Skip to content

Latest commit

 

History

History
256 lines (193 loc) · 9.21 KB

ScreenTabFieldsApi.md

File metadata and controls

256 lines (193 loc) · 9.21 KB

ScreenTabFieldsApi

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

Method HTTP request Description
addScreenTabField POST /rest/api/3/screens/{screenId}/tabs/{tabId}/fields Add screen tab field
getAllScreenTabFields GET /rest/api/3/screens/{screenId}/tabs/{tabId}/fields Get all screen tab fields
moveScreenTabField POST /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move Move screen tab field
removeScreenTabField DELETE /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id} Remove screen tab field

addScreenTabField

ScreenableField addScreenTabField(body, screenId, tabId)

Add screen tab field

Adds a field to a screen tab. 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.ScreenTabFieldsApi;

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");

ScreenTabFieldsApi apiInstance = new ScreenTabFieldsApi();
AddFieldBean body = new AddFieldBean(); // AddFieldBean | 
Long screenId = 789L; // Long | The ID of the screen.
Long tabId = 789L; // Long | The ID of the screen tab.
try {
    ScreenableField result = apiInstance.addScreenTabField(body, screenId, tabId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ScreenTabFieldsApi#addScreenTabField");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body AddFieldBean
screenId Long The ID of the screen.
tabId Long The ID of the screen tab.

Return type

ScreenableField

Authorization

OAuth2basicAuth

HTTP request headers

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

getAllScreenTabFields

List<ScreenableField> getAllScreenTabFields(screenId, tabId, projectKey)

Get all screen tab fields

Returns all fields for a screen tab. Permissions required: * Administer Jira global permission. * Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.

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.ScreenTabFieldsApi;

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");

ScreenTabFieldsApi apiInstance = new ScreenTabFieldsApi();
Long screenId = 789L; // Long | The ID of the screen.
Long tabId = 789L; // Long | The ID of the screen tab.
String projectKey = "projectKey_example"; // String | The key of the project.
try {
    List<ScreenableField> result = apiInstance.getAllScreenTabFields(screenId, tabId, projectKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ScreenTabFieldsApi#getAllScreenTabFields");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
screenId Long The ID of the screen.
tabId Long The ID of the screen tab.
projectKey String The key of the project. [optional]

Return type

List<ScreenableField>

Authorization

OAuth2basicAuth

HTTP request headers

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

moveScreenTabField

Object moveScreenTabField(body, screenId, tabId, id)

Move screen tab field

Moves a screen tab field. If `after` and `position` are provided in the request, `position` is ignored. 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.ScreenTabFieldsApi;

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");

ScreenTabFieldsApi apiInstance = new ScreenTabFieldsApi();
MoveFieldBean body = new MoveFieldBean(); // MoveFieldBean | 
Long screenId = 789L; // Long | The ID of the screen.
Long tabId = 789L; // Long | The ID of the screen tab.
String id = "id_example"; // String | The ID of the field.
try {
    Object result = apiInstance.moveScreenTabField(body, screenId, tabId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ScreenTabFieldsApi#moveScreenTabField");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body MoveFieldBean
screenId Long The ID of the screen.
tabId Long The ID of the screen tab.
id String The ID of the field.

Return type

Object

Authorization

OAuth2basicAuth

HTTP request headers

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

removeScreenTabField

removeScreenTabField(screenId, tabId, id)

Remove screen tab field

Removes a field from a screen tab. 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.ScreenTabFieldsApi;

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");

ScreenTabFieldsApi apiInstance = new ScreenTabFieldsApi();
Long screenId = 789L; // Long | The ID of the screen.
Long tabId = 789L; // Long | The ID of the screen tab.
String id = "id_example"; // String | The ID of the field.
try {
    apiInstance.removeScreenTabField(screenId, tabId, id);
} catch (ApiException e) {
    System.err.println("Exception when calling ScreenTabFieldsApi#removeScreenTabField");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
screenId Long The ID of the screen.
tabId Long The ID of the screen tab.
id String The ID of the field.

Return type

null (empty response body)

Authorization

OAuth2basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined