Skip to content

Latest commit

 

History

History
607 lines (454 loc) · 25.7 KB

IssueTypeScreenSchemesApi.md

File metadata and controls

607 lines (454 loc) · 25.7 KB
Raw

IssueTypeScreenSchemesApi

All URIs are relative to https://your-domain.atlassian.com

Method HTTP request Description
appendMappingsForIssueTypeScreenScheme PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping Append mappings to issue type screen scheme
assignIssueTypeScreenSchemeToProject PUT /rest/api/3/issuetypescreenscheme/project Assign issue type screen scheme to project
createIssueTypeScreenScheme POST /rest/api/3/issuetypescreenscheme Create issue type screen scheme
deleteIssueTypeScreenScheme DELETE /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId} Delete issue type screen scheme
getIssueTypeScreenSchemeMappings GET /rest/api/3/issuetypescreenscheme/mapping Get issue type screen scheme items
getIssueTypeScreenSchemeProjectAssociations GET /rest/api/3/issuetypescreenscheme/project Get issue type screen schemes for projects
getIssueTypeScreenSchemes GET /rest/api/3/issuetypescreenscheme Get issue type screen schemes
removeMappingsFromIssueTypeScreenScheme POST /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove Remove mappings from issue type screen scheme
updateDefaultScreenScheme PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default Update issue type screen scheme default screen scheme
updateIssueTypeScreenScheme PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId} Update issue type screen scheme

appendMappingsForIssueTypeScreenScheme

Object appendMappingsForIssueTypeScreenScheme(body, issueTypeScreenSchemeId)

Append mappings to issue type screen scheme

Appends issue type to screen scheme mappings to an issue type screen scheme. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
IssueTypeScreenSchemeMappingDetails body = new IssueTypeScreenSchemeMappingDetails(); // IssueTypeScreenSchemeMappingDetails | 
String issueTypeScreenSchemeId = "issueTypeScreenSchemeId_example"; // String | The ID of the issue type screen scheme.
try {
    Object result = apiInstance.appendMappingsForIssueTypeScreenScheme(body, issueTypeScreenSchemeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#appendMappingsForIssueTypeScreenScheme");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body IssueTypeScreenSchemeMappingDetails
issueTypeScreenSchemeId String The ID of the issue type screen scheme.

Return type

Object

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

assignIssueTypeScreenSchemeToProject

Object assignIssueTypeScreenSchemeToProject(body)

Assign issue type screen scheme to project

Assigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic projects. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
IssueTypeScreenSchemeProjectAssociation body = new IssueTypeScreenSchemeProjectAssociation(); // IssueTypeScreenSchemeProjectAssociation | 
try {
    Object result = apiInstance.assignIssueTypeScreenSchemeToProject(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#assignIssueTypeScreenSchemeToProject");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body IssueTypeScreenSchemeProjectAssociation

Return type

Object

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createIssueTypeScreenScheme

IssueTypeScreenSchemeId createIssueTypeScreenScheme(body)

Create issue type screen scheme

Creates an issue type screen scheme. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
IssueTypeScreenSchemeDetails body = new IssueTypeScreenSchemeDetails(); // IssueTypeScreenSchemeDetails | An issue type screen scheme bean.
try {
    IssueTypeScreenSchemeId result = apiInstance.createIssueTypeScreenScheme(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#createIssueTypeScreenScheme");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body IssueTypeScreenSchemeDetails An issue type screen scheme bean.

Return type

IssueTypeScreenSchemeId

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteIssueTypeScreenScheme

Object deleteIssueTypeScreenScheme(issueTypeScreenSchemeId)

Delete issue type screen scheme

Deletes an issue type screen scheme. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
String issueTypeScreenSchemeId = "issueTypeScreenSchemeId_example"; // String | The ID of the issue type screen scheme.
try {
    Object result = apiInstance.deleteIssueTypeScreenScheme(issueTypeScreenSchemeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#deleteIssueTypeScreenScheme");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
issueTypeScreenSchemeId String The ID of the issue type screen scheme.

Return type

Object

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getIssueTypeScreenSchemeMappings

PageBeanIssueTypeScreenSchemeItem getIssueTypeScreenSchemeMappings(startAt, maxResults, issueTypeScreenSchemeId)

Get issue type screen scheme items

Returns a paginated list of issue type screen scheme items. Only issue type screen schemes used in classic projects are returned. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
Long startAt = 0L; // Long | The index of the first item to return in a page of results (page offset).
Integer maxResults = 50; // Integer | The maximum number of items to return per page.
List<Long> issueTypeScreenSchemeId = Arrays.asList(56L); // List<Long> | The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: `issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001`.
try {
    PageBeanIssueTypeScreenSchemeItem result = apiInstance.getIssueTypeScreenSchemeMappings(startAt, maxResults, issueTypeScreenSchemeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#getIssueTypeScreenSchemeMappings");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
startAt Long The index of the first item to return in a page of results (page offset). [optional] [default to 0]
maxResults Integer The maximum number of items to return per page. [optional] [default to 50]
issueTypeScreenSchemeId List<Long> The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: `issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001`. [optional]

Return type

PageBeanIssueTypeScreenSchemeItem

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getIssueTypeScreenSchemeProjectAssociations

PageBeanIssueTypeScreenSchemesProjects getIssueTypeScreenSchemeProjectAssociations(projectId, startAt, maxResults)

Get issue type screen schemes for projects

Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it. Only issue type screen schemes used in classic projects are returned. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
List<Long> projectId = Arrays.asList(56L); // List<Long> | The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.
Long startAt = 0L; // Long | The index of the first item to return in a page of results (page offset).
Integer maxResults = 50; // Integer | The maximum number of items to return per page.
try {
    PageBeanIssueTypeScreenSchemesProjects result = apiInstance.getIssueTypeScreenSchemeProjectAssociations(projectId, startAt, maxResults);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#getIssueTypeScreenSchemeProjectAssociations");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
projectId List<Long> The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.
startAt Long The index of the first item to return in a page of results (page offset). [optional] [default to 0]
maxResults Integer The maximum number of items to return per page. [optional] [default to 50]

Return type

PageBeanIssueTypeScreenSchemesProjects

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getIssueTypeScreenSchemes

PageBeanIssueTypeScreenScheme getIssueTypeScreenSchemes(startAt, maxResults, id)

Get issue type screen schemes

Returns a paginated list of issue type screen schemes. Only issue type screen schemes used in classic projects are returned. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
Long startAt = 0L; // Long | The index of the first item to return in a page of results (page offset).
Integer maxResults = 50; // Integer | The maximum number of items to return per page.
List<Long> id = Arrays.asList(56L); // List<Long> | The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
try {
    PageBeanIssueTypeScreenScheme result = apiInstance.getIssueTypeScreenSchemes(startAt, maxResults, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#getIssueTypeScreenSchemes");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
startAt Long The index of the first item to return in a page of results (page offset). [optional] [default to 0]
maxResults Integer The maximum number of items to return per page. [optional] [default to 50]
id List<Long> The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. [optional]

Return type

PageBeanIssueTypeScreenScheme

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

removeMappingsFromIssueTypeScreenScheme

Object removeMappingsFromIssueTypeScreenScheme(body, issueTypeScreenSchemeId)

Remove mappings from issue type screen scheme

Removes issue type to screen scheme mappings from an issue type screen scheme. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
IssueTypeIds body = new IssueTypeIds(); // IssueTypeIds | 
String issueTypeScreenSchemeId = "issueTypeScreenSchemeId_example"; // String | The ID of the issue type screen scheme.
try {
    Object result = apiInstance.removeMappingsFromIssueTypeScreenScheme(body, issueTypeScreenSchemeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#removeMappingsFromIssueTypeScreenScheme");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body IssueTypeIds
issueTypeScreenSchemeId String The ID of the issue type screen scheme.

Return type

Object

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateDefaultScreenScheme

Object updateDefaultScreenScheme(body, issueTypeScreenSchemeId)

Update issue type screen scheme default screen scheme

Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
UpdateDefaultScreenScheme body = new UpdateDefaultScreenScheme(); // UpdateDefaultScreenScheme | 
String issueTypeScreenSchemeId = "issueTypeScreenSchemeId_example"; // String | The ID of the issue type screen scheme.
try {
    Object result = apiInstance.updateDefaultScreenScheme(body, issueTypeScreenSchemeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#updateDefaultScreenScheme");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body UpdateDefaultScreenScheme
issueTypeScreenSchemeId String The ID of the issue type screen scheme.

Return type

Object

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateIssueTypeScreenScheme

Object updateIssueTypeScreenScheme(body, issueTypeScreenSchemeId)

Update issue type screen scheme

Updates an issue type screen scheme. Permissions required: Administer Jira global permission.

Example

// Import classes:
//import com.xminds.jira.rest.client.ApiClient;
//import com.xminds.jira.rest.client.ApiException;
//import com.xminds.jira.rest.client.Configuration;
//import com.xminds.jira.rest.client.auth.*;
//import com.xminds.jira.rest.client.api.IssueTypeScreenSchemesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: OAuth2
OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
OAuth2.setAccessToken("YOUR ACCESS TOKEN");
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

IssueTypeScreenSchemesApi apiInstance = new IssueTypeScreenSchemesApi();
IssueTypeScreenSchemeUpdateDetails body = new IssueTypeScreenSchemeUpdateDetails(); // IssueTypeScreenSchemeUpdateDetails | The issue type screen scheme update details.
String issueTypeScreenSchemeId = "issueTypeScreenSchemeId_example"; // String | The ID of the issue type screen scheme.
try {
    Object result = apiInstance.updateIssueTypeScreenScheme(body, issueTypeScreenSchemeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTypeScreenSchemesApi#updateIssueTypeScreenScheme");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body IssueTypeScreenSchemeUpdateDetails The issue type screen scheme update details.
issueTypeScreenSchemeId String The ID of the issue type screen scheme.

Return type

Object

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json