### Get all screens response example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens

Example JSON response for the get all screens request.

```json
{ "isLast": true, "maxResults": 100, "self": "https://your-domain.atlassian.net/rest/api/3/screens", "startAt": 0, "total": 3, "values": [ { "id": 1, "name": "Default Screen", "description": "Provides for the update all system fields." }, { "id": 2, "name": "Workflow Screen", "description": "This screen is used in the workflow and enables you to assign issues." }, { "id": 3, "name": "Resolve Issue Screen", "description": "Offers the ability to set resolution, change fix versions, and assign an issue." } ] }
```

--------------------------------

### Example Request for Fetching Workspaces

Source: https://developer.atlassian.com/cloud/jira/platform/modules/operations-information

This snippet shows an example GET request URL for fetching operations workspaces. The `searchQuery` parameter is used to filter the results.

```json
"https://my.security.provider.com/containers/search?searchQuery=my-container-name"
```

--------------------------------

### Example ngrok forwarding output

Source: https://developer.atlassian.com/cloud/jira/platform/getting-started

This is an example of the console UI you will see in your terminal after starting ngrok, showing the forwarding URL.

```text
Forwarding                    https://84c5df439d74.ngrok-free.dev -> http://localhost:8000
```

--------------------------------

### App Descriptor URL Example

Source: https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect

The URL pointing to the hosted atlassian-connect.json file required for app installation.

```shell
https://bb5a163ef415.ngrok.io/atlassian-connect.json
```

--------------------------------

### Get Atlassian Team Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan

Example JSON response for retrieving an Atlassian team's planning settings within a plan.

```json
{ "capacity": 220, "id": "98WA-2JBO-12N3-2298", "issueSourceId": 1, "planningStyle": "Scrum", "sprintLength": 2 }
```

--------------------------------

### App Descriptor Example

Source: https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps

This JSON snippet shows essential elements for a Connect app descriptor, including authentication type, installation callback, and scopes.

```json
{
    "baseUrl": "http://localhost:3000",
    "key": "atlassian-connect-app",
    "authentication": {
        "type": "jwt"
    },
    "lifecycle": {
        "installed": "/app-installed-callback"
    },
    "scopes": [
        "read", "write"
    ],
    "modules": {} // etc
}
```

--------------------------------

### Get all project versions response

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions

Example JSON response structure for a request to list all project versions.

```json
[ { "archived": false, "description": "An excellent version", "id": "10000", "name": "New Version 1", "overdue": true, "projectId": 10000, "releaseDate": 1278385482288, "releaseDateSet": true, "released": true, "self": "https://your-domain.atlassian.net/rest/api/3/version/10000", "startDateSet": false, "userReleaseDate": "6/Jul/2010" }, { "archived": false, "description": "Minor Bugfix version", "id": "10010", "issuesStatusForFixVersion": { "done": 100, "inProgress": 20, "toDo": 10, "unmapped": 0 }, "name": "Next Version", "overdue": false, "projectId": 10000, "releaseDateSet": false, "released": false, "self": "https://your-domain.atlassian.net/rest/api/3/version/10010", "startDateSet": false } ]
```

--------------------------------

### Example response for Get all fields

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields

A sample JSON response body returned when successfully fetching field details.

```json
[ { "clauseNames": [ "description" ], "custom": false, "id": "description", "name": "Description", "navigable": true, "orderable": true, "schema": { "system": "description", "type": "string" }, "searchable": true }, { "clauseNames": [ "summary" ], "custom": false, "id": "summary", "key": "summary", "name": "Summary", "navigable": true, "orderable": true, "schema": { "system": "summary", "type": "string" }, "searchable": true } ]
```

--------------------------------

### Full routes/index.js Example

Source: https://developer.atlassian.com/cloud/jira/platform/project-activity

Complete example of the routes/index.js file, including the new '/activity' route and existing '/hello-world' route.

```javascript
export default function routes(app, addon) {
	// Redirect root path to /atlassian-connect.json,
	// which will be served by atlassian-connect-express.
	app.get('/', (req, res) => {
		res.redirect('/atlassian-connect.json');
	});

	// This is an example route used by "generalPages" module (see atlassian-connect.json).
	// Verify that the incoming request is authenticated with Atlassian Connect.
	app.get('/hello-world', addon.authenticate(), (req, res) => {
		// Rendering a template is easy; the render method takes two params:
		// name of template and a json object to pass the context in.
		res.render('hello-world', {
			title: 'Atlassian Connect'
			//issueId: req.query['issueId']
		});
	});

	// Add additional route handlers here...

	app.get('/activity', addon.authenticate(), function(req, res) {
		res.render('activity', { title: "Jira activity" });
	});
}
```

--------------------------------

### Start Local Web Server

Source: https://developer.atlassian.com/cloud/jira/platform/getting-started

Start the http-server on port 8000 to serve your project files.

```bash
http-server -p 8000

```

--------------------------------

### Get screens for a field response example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens

Example JSON response for the get screens for a field request.

```json
{ "isLast": false, "maxResults": 1, "startAt": 0, "total": 5, "values": [ { "id": 10001, "name": "Default Screen", "description": "Provides for the update of all system fields.", "tab": { "id": 10000, "name": "Fields Tab" } } ] }
```

--------------------------------

### Example Page Module Configuration

Source: https://developer.atlassian.com/cloud/jira/platform/modules/page

This JSON snippet demonstrates the structure for defining generalPages and a postInstallPage within the descriptor. It includes configurations for page URLs, icons, and names.

```json
{
  "modules": {
    "generalPages": [
      {
        "url": "/my-general-page",
        "icon": {
          "width": 80,
          "height": 80,
          "url": "/maps/icon.png"
        },
        "name": {
          "value": "My General Page"
        },
        "key": "my-general-page"
      }
    ],
    "postInstallPage": {
      "url": "/my-post-install-page",
      "name": {
        "value": "My Post-Install Page",
        "i18n": "mypostinstallpage.name"
      },
      "key": "my-post-install-page"
    }
  }
}
```

--------------------------------

### Get plans paginated response example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-plans

Example JSON response structure returned by the GET /rest/api/3/plans/plan endpoint.

```json
{ "cursor": "", "isLast": true, "maxResults": 2, "nextPageCursor": "2", "total": 10, "values": [ { "id": "100", "issueSources": [ { "type": "Project", "value": 10000 } ], "name": "Plan 1", "scenarioId": "200", "status": "Active" }, { "id": "200", "issueSources": [ { "type": "Board", "value": 20000 } ], "name": "Plan 2", "scenarioId": "300", "status": "Trashed" } ] }
```

--------------------------------

### Example Repository Search Request

Source: https://developer.atlassian.com/cloud/jira/platform/modules/development-tool

This GET request demonstrates searching for repositories with optional searchQuery, page, and limit query parameters. searchQuery matches against repository names.

```http
"https://my.devinfo.provider.com/repos/search?searchQuery=my-repo-name&page=3&limit=50"
```

--------------------------------

### Bulk get statuses response example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status

Example JSON response body returned by the bulk get statuses endpoint.

```json
1 2 3 4 5 6 7 8 9 10 11 12 13 14 [ { "description": "The issue is resolved", "id": "1000", "name": "Finished", "scope": { "project": { "id": "1" }, "type": "PROJECT" }, "statusCategory": "DONE" } ]
```

--------------------------------

### Example Response for Create Repository Action

Source: https://developer.atlassian.com/cloud/jira/platform/modules/development-tool

This is an example response for the createRepository action, returning the details of the newly created repository.

```json
{
  // Identifier of the repository which will be used to hydrate repository details
  "id": "f730ce9c-3442-4f8a-93a4-a44f3b35c46b/target/111-222-333",
  // Human readable name of the repository
  "name": "my-repo-name",
  // Url allowing Jira to link directly to the provider's repository
  "url": "https://my.devinfo.provider.com/f730ce9c-3442-4f8a-93a4-a44f3b35c46b/repo/f730ce9c-3442-4f8a-93a4-a44f3b35c46b",
  // Optional, url providing the avatar for the repository.
  "avatarUrl": "https://res.cloudinary.com/snyk/image/upload/v1584038122/groups/Atlassian_Logo.png",
  // The date and time this repository was last scanned/updated
  "lastUpdatedDate": "2022-01-19T23:27:25+00:00"
}
```

--------------------------------

### Example response for Get contexts for a field

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields

An example JSON response for the 'Get contexts for a field' endpoint, illustrating context details.

```json
{ "isLast": false, "maxResults": 1, "startAt": 0, "total": 5, "values": [ { "id": 10001, "name": "Default Context" } ] }
```

--------------------------------

### Create Field Configuration Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations

Example JSON response after successfully creating a field configuration.

```json
{ "description": "My field configuration description", "id": 10001, "name": "My Field Configuration" }
```

--------------------------------

### Example response for Get field project associations

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields

An example JSON response structure for the 'Get field project associations' endpoint, showing project IDs.

```json
{ "isLast": false, "maxResults": 50, "startAt": 0, "total": 2, "values": [ { "projectId": "10010" }, { "projectId": "10020" } ] }
```

--------------------------------

### Lifecycle HTTP Request Payload Example

Source: https://developer.atlassian.com/cloud/jira/platform/add-on-descriptor

This is an example of the JSON payload received during a lifecycle event, such as add-on installation. It contains essential tenant and installation details.

```json
{
  "key": "installed-addon-key",
  "clientKey": "unique-client-identifier",
  "sharedSecret": "a-secret-key-not-to-be-lost",
  "serverVersion": "server-version",
  "pluginsVersion": "version-of-connect",
  "baseUrl": "https://example.atlassian.net",
  "displayUrl": "https://issues.example.com",
  "displayUrlServicedeskHelpCenter": "https://support.example.com",
  "productType": "jira",
  "description": "Atlassian Jira at https://example.atlassian.net",
  "serviceEntitlementNumber": "SEN-number",
  "entitlementId": "Entitlement-Id",
  "entitlementNumber": "Entitlement-Number",
  "eventType": "installed",
  "installationId": "ari:cloud:ecosystem::installation/uuid-of-forge-installation-identifier"
}
```

--------------------------------

### Basic Example: Emitting and Listening to Events

Source: https://developer.atlassian.com/cloud/jira/platform/jsapi/events

Demonstrates how to emit a custom event and a public event from one add-on, and how to listen for a public event in another add-on.

```APIDOC
## Basic example

Add-on A:
```javascript
// The following will create an alert message every time the event `customEvent` is triggered.
AP.events.on('customEvent', function(){
  alert('event fired');
});

AP.events.emit('customEvent');
AP.events.emitPublic('customPublicEvent');
```

Add-on B:
```javascript
// The following will create an alert message every time the event `customPublicEvent` is triggered by add-on A.
AP.events.onPublic('customPublicEvent', function(){
  alert('public event fired');
});
```
```

--------------------------------

### Example Request for Create Repository Action

Source: https://developer.atlassian.com/cloud/jira/platform/modules/development-tool

This example shows the POST request URL and body for the createRepository action, specifying the workspace ID and the desired repository name.

```json
"https://my.devinfo.provider.com/repos/create"

Body: {
  "workspaceId": "12345",
  "name": "my-repo-name"
}
```

--------------------------------

### Example Response for Get Create Issue Metadata

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues

Example JSON response structure for the 'Get create issue metadata' endpoint, detailing project and issue type information.

```json
{
  "projects": [
    {
      "avatarUrls": {
        "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
        "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
        "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011",
        "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011"
      },
      "id": "10000",
      "issuetypes": [
        {
          "description": "An error in the code",
          "fields": {
            "issuetype": {
              "allowedValues": [ "set" ],
              "autoCompleteUrl": "issuetype",
              "hasDefaultValue": false,
              "key": "issuetype",
              "name": "Issue Type",
              "required": true
            }
          },
          "iconUrl": "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
          "id": "1",
          "name": "Bug",
          "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
          "subtask": false
        }
      ],
      "key": "ED",
      "name": "Edison Project",
      "self": "https://your-domain.atlassian.net/rest/api/3/project/ED"
    }
  ]
}
```

--------------------------------

### Example Add-on Descriptor

Source: https://developer.atlassian.com/cloud/jira/platform/add-on-descriptor

A complete example of an Atlassian Connect add-on descriptor file.

```json
{
  "modules": {},
  "key": "my-app-key",
  "name": "My Connect App",
  "description": "A connect app that does something",
  "vendor": {
    "name": "My Company",
    "url": "http://www.example.com"
  },
  "links": {
    "self": "http://www.example.com/connect/jira/atlassian-connect.json"
  },
  "lifecycle": {
    "installed": "/installed",
    "uninstalled": "/uninstalled"
  },
  "baseUrl": "http://www.example.com/connect/jira",
  "authentication": {
    "type": "jwt"
  },
  "enableLicensing": true,
  "scopes": [
    "read",
    "write"
  ],
  "cloudAppMigration": {
    "migrationWebhookPath" : "/app-migration-events-webhook"
  }
}
```

--------------------------------

### Response for get workflow

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts

Example JSON response structure for the get workflow request.

```json
{ "defaultMapping": false, "issueTypes": [ "10000", "10001" ], "workflow": "jira" }
```

--------------------------------

### Example URL with Jira Project and Issue Context Parameters

Source: https://developer.atlassian.com/cloud/jira/platform/context-parameters

This example demonstrates how to include Jira project ID and issue key as context parameters in a URL. The parameters are bound at runtime and can be used as path components or query string values.

```json
{
    "url": "/myPage/projects/{project.id}?issueKey={issue.key}"
}
```

--------------------------------

### Get Issue Watchers Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-watchers

This is an example of the JSON response when retrieving watchers for an issue.

```json
{
  "isWatching": false,
  "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
  "watchCount": 1,
  "watchers": [
    {
      "accountId": "5b10a2844c20165700ede21g",
      "active": false,
      "displayName": "Mia Krystof",
      "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
    }
  ]
}
```

--------------------------------

### Example Response for Get Create Issue Metadata for Project

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues

Example JSON response structure for the 'Get create metadata issue types for a project' endpoint, detailing issue types available for a given project.

```json
{
  "issueTypes": [
    {
      "description": "An error in the code",
      "iconUrl": "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
      "id": "1",
      "name": "Bug",
      "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
      "subtask": false
    }
  ],
  "maxResults": 1,
  "startAt": 0,
  "total": 1
}
```

--------------------------------

### Example Workspace Search Request

Source: https://developer.atlassian.com/cloud/jira/platform/modules/development-tool

This GET request demonstrates how to search for workspaces using a searchQuery parameter. The searchQuery is optional and is matched against workspace names.

```http
https://my.devinfo.provider.com/repos/search?searchQuery=my-workspace-name
```

--------------------------------

### Get Priority Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities

Example JSON response for a single issue priority when retrieved by its ID.

```json
{ "description": "Major loss of function.", "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/major.png", "id": "1", "name": "Major", "self": "https://your-domain.atlassian.net/rest/api/3/priority/3", "statusColor": "#009900" }
```

--------------------------------

### Example Connect App Descriptor

Source: https://developer.atlassian.com/cloud/jira/platform/add-on-descriptor

This is a basic example of an atlassian-connect.json file. It includes general information about the app and defines a few modules.

```json
{
  "key": "com.example.app",
  "name": "My Sample App",
  "baseUrl": "https://example.com",
  "vendor": {
    "name": "Atlassian",
    "url": "https://atlassian.com"
  },
  "authentication": {
    "type": "jwt"
  },
  "lifecycle": {
    "installed": "/installed",
    "uninstalled": "/uninstalled",
    "enabled": "/enabled",
    "disabled": "/disabled"
  },
  "scopes": [
    "READ", "WRITE"
  ],
  "modules": {
    "jiraPages": [
      {
        "url": "/",
        "name": {
          "value": "My Sample App"
        },
        "key": "main-page"
      }
    ]
  }
}
```

--------------------------------

### Get all dashboards response example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards

Example JSON response body for a successful request to retrieve all dashboards.

```json
{ "dashboards": [ { "id": "10000", "isFavourite": false, "name": "System Dashboard", "popularity": 1, "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000", "sharePermissions": [ { "type": "global" } ], "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000" }, { "id": "20000", "isFavourite": true, "name": "Build Engineering", "owner": { "key": "Mia", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "name": "mia", "displayName": "Mia Krystof", "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" } }, "popularity": 1, "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/20000", "sharePermissions": [ { "group": { "name": "administrators", "self": "https://your-domain.atlassian.net/rest/api/3/group?groupname=administrators" }, "id": 10105, "type": "group" } ], "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000" } ], "maxResults": 10, "next": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=10", "prev": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=0", "startAt": 10, "total": 143 }
```

--------------------------------

### Navigate to Java Directory

Source: https://developer.atlassian.com/cloud/jira/platform/jira-rest-api-oauth-authentication

Navigate to the 'java' directory within the cloned atlassian-oauth-examples repository.

```bash
cd atlassian-oauth-examples/java
```

--------------------------------

### Start local web server

Source: https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect

Start the http-server on port 8000 to serve your app's files. This command makes your `atlassian-connect.json` and `helloworld.html` accessible via localhost.

```shell
http-server -p 8000
```

--------------------------------

### Get Teams Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan

Example JSON response structure for retrieving teams in a plan, showing pagination and team details.

```json
{ "cursor": "", "isLast": true, "maxResults": 2, "nextPageCursor": "2", "total": 10, "values": [ { "id": "1", "name": "Team 1", "type": "PlanOnly" }, { "id": "2", "type": "Atlassian" } ] }
```

--------------------------------

### All Permissions Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions

Example JSON response when retrieving all permissions, showing the 'Bulk Change' global permission.

```json
{
  "permissions": {
    "BULK_CHANGE": {
      "description": "Ability to modify a collection of issues at once. For example, resolve multiple issues in one step.",
      "key": "BULK_CHANGE",
      "name": "Bulk Change",
      "type": "GLOBAL"
    }
  }
}
```

--------------------------------

### Get Users from Group Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups

Example JSON response for retrieving users from a group, including pagination details and user information.

```json
{ "isLast": false, "maxResults": 2, "nextPage": "https://your-domain.atlassian.net/rest/api/3/group/member?groupId=276f955c-63d7-42c8-9520-92d01dca0625&includeInactiveUsers=false&startAt=4&maxResults=2", "self": "https://your-domain.atlassian.net/rest/api/3/group/member?groupId=276f955c-63d7-42c8-9520-92d01dca0625&includeInactiveUsers=false&startAt=2&maxResults=2", "startAt": 3, "total": 5, "values": [ { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": true, "avatarUrls": {}, "displayName": "Mia", "emailAddress": "mia@example.com", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "timeZone": "Australia/Sydney" }, { "accountId": "5b10a0effa615349cb016cd8", "accountType": "atlassian", "active": false, "avatarUrls": {}, "displayName": "Will", "emailAddress": "will@example.com", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a0effa615349cb016cd8", "timeZone": "Australia/Sydney" } ] }
```

--------------------------------

### Get Jira Attachment Thumbnail using Forge

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments

Retrieves the thumbnail of a Jira attachment. This Forge SDK example logs the response status and text. Use 'Get attachment content' to get the full attachment.

```javascript
// This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ 
import { requestJira } from "@forge/bridge";
const response = await requestJira(`/rest/api/3/attachment/thumbnail/{id}`);
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());
```

--------------------------------

### Example App Descriptor

Source: https://developer.atlassian.com/cloud/jira/platform/app-descriptor

A basic example of an atlassian-connect.json file. This descriptor includes general information about the app and declares a page module.

```json
{
  "key": "com.example.my-app",
  "name": "My Sample App",
  "baseUrl": "https://example.com/my-app",
  "vendor": {
    "name": "Atlassian",
    "url": "https://developer.atlassian.com"
  },
  "authentication": {
    "type": "jwt"
  },
  "enabled": true,
  "scopes": [
    "read",
    "write"
  ],
  "modules": {
    "page": [
      {
        "url": "/",
        "key": "main-page"
      }
    ]
  }
}
```

--------------------------------

### Example Response for Create Field Metadata

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues

Example JSON response structure for the 'Get create field metadata' endpoint, detailing available fields and their properties.

```json
{ "fields": [ { "fieldId": "assignee", "hasDefaultValue": false, "key": "assignee", "name": "Assignee", "operations": [ "set" ], "required": true } ], "maxResults": 1, "startAt": 0, "total": 1 }
```

--------------------------------

### Start Jira App Deployment

Source: https://developer.atlassian.com/cloud/jira/platform/build-a-jira-app-using-a-framework

Run this command in your project directory to start the Express server and deploy your Jira app. The framework handles ngrok tunneling and app registration.

```bash
npm start
```

--------------------------------

### Example Created Field Configuration Scheme Response

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations

This is an example of a successful response after creating a new field configuration scheme. It returns the details of the newly created scheme, including its ID, name, and description.

```json
{
  "description": "We can use this one for software projects.",
  "id": "10002",
  "name": "Field Configuration Scheme for software related projects"
}
```

--------------------------------

### Get All Labels Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels

Example JSON response when successfully retrieving a list of labels. Note the pagination details and the 'values' array containing the labels.

```json
{ "isLast": false, "maxResults": 2, "startAt": 0, "total": 100, "values": [ "performance", "security" ] }
```

--------------------------------

### Create a screen response example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens

Example JSON response for the create screen request.

```json
{ "id": 10005, "name": "Resolve Security Issue Screen", "description": "Enables changes to resolution and linked issues." }
```

--------------------------------

### Jira Issue Type Alternatives Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types

Example JSON response for the Get alternative issue types resource, detailing available issue types with their properties.

```json
[ { "avatarId": 1, "description": "A task that needs to be done.", "hierarchyLevel": 0, "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",", "id": "3", "name": "Task", "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3", "subtask": false }, { "avatarId": 10002, "description": "A problem with the software.", "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2", "hierarchyLevel": 0, "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",", "id": "1", "name": "Bug", "scope": { "project": { "id": "10000" }, "type": "PROJECT" }, "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1", "subtask": false } ]
```

--------------------------------

### Get Issue Link Type Response Example

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types

Example JSON response for retrieving a single issue link type. This object defines the relationship between linked issues.

```json
{ "id": "1000", "inward": "Duplicated by", "name": "Duplicate", "outward": "Duplicates", "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000" }
```

--------------------------------

### Example response for project list

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes

A sample JSON response body containing a paginated list of project details.

```json
{ "isLast": true, "maxResults": 100, "startAt": 0, "total": 1, "values": [ { "avatarUrls": { "16x16": "secure/projectavatar?size=xsmall&pid=10000", "24x24": "secure/projectavatar?size=small&pid=10000", "32x32": "secure/projectavatar?size=medium&pid=10000", "48x48": "secure/projectavatar?size=large&pid=10000" }, "id": "10000", "key": "EX", "name": "Example", "projectCategory": { "description": "Project category description", "id": "10000", "name": "A project category" }, "projectTypeKey": "ProjectTypeKey{key='software'}", "self": "project/EX", "simplified": false } ] }
```

--------------------------------

### Example JSON Response for Get Options

Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options--apps-

This is an example of the JSON response when retrieving selectable issue field options. It includes pagination details and the list of option values.

```json
{ "isLast": false, "maxResults": 1, "nextPage": "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=1&maxResults=1", "self": "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=0&maxResults=1", "startAt": 0, "total": 10, "values": [ { "id": 1, "value": "Team 1", "properties": { "leader": { "name": "Leader Name", "email": "lname@example.com" }, "members": 42, "description": "The team's description", "founded": "2016-06-06" }, "config": { "scope": { "projects": [], "projects2": [ { "id": 1001, "attributes": [ "notSelectable" ] }, { "id": 1002, "attributes": [ "notSelectable" ] } ], "global": {} }, "attributes": [] } } ] }
```