/
10.API response dump - Atlassian Project
10.API response dump - Atlassian Project
- Below are the fields and API with their responses listed out for Jira Audit app
NO | FIELDS | DESCRIPTION | API TO REFER IN DOCUMENTATION | API LINKS | COMMENTS |
---|---|---|---|---|---|
1 | PROJECTS | Returns projects visible to the user | Get projects paginated | https://empyrajira.atlassian.net/rest/api/3/project/search?expand=projectKeys,lead,issueTypes | This API will fetch us the details of Projects, Project Lead, Project Keys, Issue Types |
2 | PROJECT KEY | Returns project keys associated with projects | Get projects paginated | https://empyrajira.atlassian.net/rest/api/3/project/search?expand=projectKeys,lead,issueTypes | This API will fetch us the details of Projects, Project Lead, Project Keys, Issue Types |
3 | PROJECT LEAD | Returns project lead associated with projects visible to the user | Get projects paginated | https://empyrajira.atlassian.net/rest/api/3/project/search?expand=projectKeys,lead,issueTypes | This API will fetch us the details of Projects, Project Lead, Project Keys, Issue Types |
4 | WORKFLOWS | Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it | Get workflow scheme project associations | https://empyrajira.atlassian.net/rest/api/3/workflowscheme/project?projectId={id} | This API will fetch us details of Workflow Schemes, and Workflows. Providing Project Id is mandatory. |
5 | WORKFLOW SCHEMES | Returns a list of the workflow schemes associated with a list of projects. | Get workflow scheme project associations | https://empyrajira.atlassian.net/rest/api/3/workflowscheme/project?projectId={id} | This API will fetch us details of Workflow Schemes, and Workflows. Providing Project Id is mandatory. |
6 | STATUS | Returns the valid statuses for a project | Get all statuses for project | https://empyrajira.atlassian.net/rest/api/3/project/{projectKey}/statuses | This API will fetch us Statuses related to all the Issue Types in specific project. Providing Project Key is mandatory. |
7 | FIELD SCHEMES | - | NOT AVAILABLE | Need additional logic after API response to get the data | |
8 | ISSUE TYPES | Returns issue types associated with projects visible to the user | Get projects paginated | https://empyrajira.atlassian.net/rest/api/3/project/search?expand=projectKeys,lead,issueTypes | This API will fetch us the details of Projects, Project Lead, Project Keys, Issue Types |
9 | SCREEN SCHEMES | - | NOT AVAILABLE | Need additional logic after API response to get the data | |
10 | PERMISSION SCHEME | Gets the permission scheme associated with the project | Get assigned permission scheme | https://empyrajira.atlassian.net/rest/api/3/project/{projectKey}/permissionscheme | This API will fetch us the permission schemes related to a project. Providing Project Key is mandatory. |
11 | NOTIFICATION SCHEME | Gets a notification scheme associated with the project | Get project notification scheme | https://empyrajira.atlassian.net/rest/api/3/project/{projectKey}/notificationscheme | This API will fetch us the notification schemes related to a project. Providing Project Key is mandatory. |
API Responses for above fields captured in Excel:
API Responses for above fields in JSON:
FIELDS: PROJECTS, PROJECT LEAD, ISSUE TYPES
{ "self": "https://empyrajira.atlassian.net/rest/api/3/project/search?expand=projectKeys,lead,issueTypes&maxResults=2&startAt=0", "nextPage": "https://empyrajira.atlassian.net/rest/api/3/project/search?expand=projectKeys,lead,issueTypes&maxResults=2&startAt=2", "maxResults": 2, "startAt": 0, "total": 47, "isLast": false, "values": [ { "expand": "description,lead,issueTypes,url,projectKeys,permissions", "self": "https://empyrajira.atlassian.net/rest/api/3/project/11403", "id": "11403", "key": "AP", "lead": { "self": "https://empyrajira.atlassian.net/rest/api/3/user?accountId=557058:c2e93520-2316-4b49-9ef4-93009bad9ab2", "key": "travisa", "accountId": "557058:c2e93520-2316-4b49-9ef4-93009bad9ab2", "name": "travisa", "avatarUrls": { "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:c2e93520-2316-4b49-9ef4-93009bad9ab2/afc46f62-8abe-481a-b124-10d557c6b689/128?size=48&s=48", "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:c2e93520-2316-4b49-9ef4-93009bad9ab2/afc46f62-8abe-481a-b124-10d557c6b689/128?size=24&s=24", "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:c2e93520-2316-4b49-9ef4-93009bad9ab2/afc46f62-8abe-481a-b124-10d557c6b689/128?size=16&s=16", "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:c2e93520-2316-4b49-9ef4-93009bad9ab2/afc46f62-8abe-481a-b124-10d557c6b689/128?size=32&s=32" }, "displayName": "Travis Alexander", "active": true }, "issueTypes": [ { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10002", "id": "10002", "description": "A small, distinct pieces of work.", "iconUrl": "https://empyrajira.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype", "name": "Task", "subtask": false, "avatarId": 10318 }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10003", "id": "10003", "description": "A small piece of work that's part of a larger task.", "iconUrl": "https://empyrajira.atlassian.net/secure/viewavatar?size=medium&avatarId=10316&avatarType=issuetype", "name": "Sub-task", "subtask": true, "avatarId": 10316 }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10001", "id": "10001", "description": "Functionality or a feature expressed as a user goal.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/issuetypes/story.svg", "name": "Story", "subtask": false }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10004", "id": "10004", "description": "A problem or error.", "iconUrl": "https://empyrajira.atlassian.net/secure/viewavatar?size=medium&avatarId=10303&avatarType=issuetype", "name": "Bug", "subtask": false, "avatarId": 10303 }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10000", "id": "10000", "description": "A collection of related bugs, stories, and tasks.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/issuetypes/epic.svg", "name": "Epic", "subtask": false }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10011", "id": "10011", "description": "Used for Recording Time for past and future events", "iconUrl": "https://empyrajira.atlassian.net/secure/viewavatar?size=medium&avatarId=10901&avatarType=issuetype", "name": "Time Record", "subtask": false, "avatarId": 10901 } ], "name": "Atlassian Projects", "avatarUrls": { "48x48": "https://empyrajira.atlassian.net/secure/projectavatar?pid=11403&avatarId=10201", "24x24": "https://empyrajira.atlassian.net/secure/projectavatar?size=small&s=small&pid=11403&avatarId=10201", "16x16": "https://empyrajira.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=11403&avatarId=10201", "32x32": "https://empyrajira.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=11403&avatarId=10201" }, "projectKeys": [ "AP" ], "projectCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/projectCategory/10100", "id": "10100", "name": "Atlassian Consulting", "description": "Empyra Atlassian Expert consulting projects." }, "projectTypeKey": "software", "simplified": false, "style": "classic", "isPrivate": false, "properties": {} }, { "expand": "description,lead,issueTypes,url,projectKeys,permissions", "self": "https://empyrajira.atlassian.net/rest/api/3/project/10108", "id": "10108", "key": "APP", "lead": { "self": "https://empyrajira.atlassian.net/rest/api/3/user?accountId=557058:b1012f55-8846-4da0-aa22-acf52a80491e", "key": "sharmendrav", "accountId": "557058:b1012f55-8846-4da0-aa22-acf52a80491e", "name": "SharmendraV", "avatarUrls": { "48x48": "https://secure.gravatar.com/avatar/ed5e78dd630ac47fbdfc78084de337d6?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png&size=48&s=48", "24x24": "https://secure.gravatar.com/avatar/ed5e78dd630ac47fbdfc78084de337d6?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png&size=24&s=24", "16x16": "https://secure.gravatar.com/avatar/ed5e78dd630ac47fbdfc78084de337d6?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png&size=16&s=16", "32x32": "https://secure.gravatar.com/avatar/ed5e78dd630ac47fbdfc78084de337d6?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png&size=32&s=32" }, "displayName": "sharmendra", "active": true }, "issueTypes": [ { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10004", "id": "10004", "description": "A problem or error.", "iconUrl": "https://empyrajira.atlassian.net/secure/viewavatar?size=medium&avatarId=10303&avatarType=issuetype", "name": "Bug", "subtask": false, "avatarId": 10303 }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10002", "id": "10002", "description": "A small, distinct pieces of work.", "iconUrl": "https://empyrajira.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype", "name": "Task", "subtask": false, "avatarId": 10318 }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10003", "id": "10003", "description": "A small piece of work that's part of a larger task.", "iconUrl": "https://empyrajira.atlassian.net/secure/viewavatar?size=medium&avatarId=10316&avatarType=issuetype", "name": "Sub-task", "subtask": true, "avatarId": 10316 }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10001", "id": "10001", "description": "Functionality or a feature expressed as a user goal.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/issuetypes/story.svg", "name": "Story", "subtask": false }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10000", "id": "10000", "description": "A collection of related bugs, stories, and tasks.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/issuetypes/epic.svg", "name": "Epic", "subtask": false } ], "name": "Atlassian Apps", "avatarUrls": { "48x48": "https://empyrajira.atlassian.net/secure/projectavatar?pid=10108&avatarId=10009", "24x24": "https://empyrajira.atlassian.net/secure/projectavatar?size=small&s=small&pid=10108&avatarId=10009", "16x16": "https://empyrajira.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=10108&avatarId=10009", "32x32": "https://empyrajira.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=10108&avatarId=10009" }, "projectKeys": [ "APP", "HCM" ], "projectCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/projectCategory/10100", "id": "10100", "name": "Atlassian Consulting", "description": "Empyra Atlassian Expert consulting projects." }, "projectTypeKey": "software", "simplified": false, "style": "classic", "isPrivate": false, "properties": {} } ] }
FIELD: WORKFLOW SCHEME, WORKFLOW
{ "values": [ { "projectIds": [ "10108" ], "workflowScheme": { "id": 11559, "name": "Basic WorkFlow Scheme for all projects", "description": "use for all", "defaultWorkflow": "jira", "issueTypeMappings": { "10000": "CYN Epics", "10001": "CYN Bug/Task/Subtask June 2018", "10002": "CYN Bug/Task/Subtask June 2018", "10004": "CYN Bug/Task/Subtask June 2018" }, "self": "https://empyrajira.atlassian.net/rest/api/3/workflowscheme/11559" } } ] }
FIELD: STATUS
[ { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10002", "id": "10002", "name": "Task", "subtask": false, "statuses": [ { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10100", "description": "", "iconUrl": "https://empyrajira.atlassian.net/images/icons/status_generic.gif", "name": "To Do", "id": "10100", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/2", "id": 2, "key": "new", "colorName": "blue-gray", "name": "To Do" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/3", "description": "This issue is being actively worked on at the moment by the assignee.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/statuses/inprogress.png", "name": "In Progress", "id": "3", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/4", "id": 4, "key": "indeterminate", "colorName": "yellow", "name": "In Progress" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10002", "description": "", "iconUrl": "https://empyrajira.atlassian.net/", "name": "Done", "id": "10002", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/3", "id": 3, "key": "done", "colorName": "green", "name": "Done" } } ] }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10003", "id": "10003", "name": "Sub-task", "subtask": true, "statuses": [ { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10100", "description": "", "iconUrl": "https://empyrajira.atlassian.net/images/icons/status_generic.gif", "name": "To Do", "id": "10100", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/2", "id": 2, "key": "new", "colorName": "blue-gray", "name": "To Do" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/3", "description": "This issue is being actively worked on at the moment by the assignee.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/statuses/inprogress.png", "name": "In Progress", "id": "3", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/4", "id": 4, "key": "indeterminate", "colorName": "yellow", "name": "In Progress" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10002", "description": "", "iconUrl": "https://empyrajira.atlassian.net/", "name": "Done", "id": "10002", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/3", "id": 3, "key": "done", "colorName": "green", "name": "Done" } } ] }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10001", "id": "10001", "name": "Story", "subtask": false, "statuses": [ { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10100", "description": "", "iconUrl": "https://empyrajira.atlassian.net/images/icons/status_generic.gif", "name": "To Do", "id": "10100", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/2", "id": 2, "key": "new", "colorName": "blue-gray", "name": "To Do" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/3", "description": "This issue is being actively worked on at the moment by the assignee.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/statuses/inprogress.png", "name": "In Progress", "id": "3", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/4", "id": 4, "key": "indeterminate", "colorName": "yellow", "name": "In Progress" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10002", "description": "", "iconUrl": "https://empyrajira.atlassian.net/", "name": "Done", "id": "10002", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/3", "id": 3, "key": "done", "colorName": "green", "name": "Done" } } ] }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10004", "id": "10004", "name": "Bug", "subtask": false, "statuses": [ { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10100", "description": "", "iconUrl": "https://empyrajira.atlassian.net/images/icons/status_generic.gif", "name": "To Do", "id": "10100", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/2", "id": 2, "key": "new", "colorName": "blue-gray", "name": "To Do" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/3", "description": "This issue is being actively worked on at the moment by the assignee.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/statuses/inprogress.png", "name": "In Progress", "id": "3", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/4", "id": 4, "key": "indeterminate", "colorName": "yellow", "name": "In Progress" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10002", "description": "", "iconUrl": "https://empyrajira.atlassian.net/", "name": "Done", "id": "10002", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/3", "id": 3, "key": "done", "colorName": "green", "name": "Done" } } ] }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10000", "id": "10000", "name": "Epic", "subtask": false, "statuses": [ { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10100", "description": "", "iconUrl": "https://empyrajira.atlassian.net/images/icons/status_generic.gif", "name": "To Do", "id": "10100", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/2", "id": 2, "key": "new", "colorName": "blue-gray", "name": "To Do" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/3", "description": "This issue is being actively worked on at the moment by the assignee.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/statuses/inprogress.png", "name": "In Progress", "id": "3", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/4", "id": 4, "key": "indeterminate", "colorName": "yellow", "name": "In Progress" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10002", "description": "", "iconUrl": "https://empyrajira.atlassian.net/", "name": "Done", "id": "10002", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/3", "id": 3, "key": "done", "colorName": "green", "name": "Done" } } ] }, { "self": "https://empyrajira.atlassian.net/rest/api/3/issuetype/10011", "id": "10011", "name": "Time Record", "subtask": false, "statuses": [ { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10100", "description": "", "iconUrl": "https://empyrajira.atlassian.net/images/icons/status_generic.gif", "name": "To Do", "id": "10100", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/2", "id": 2, "key": "new", "colorName": "blue-gray", "name": "To Do" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/3", "description": "This issue is being actively worked on at the moment by the assignee.", "iconUrl": "https://empyrajira.atlassian.net/images/icons/statuses/inprogress.png", "name": "In Progress", "id": "3", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/4", "id": 4, "key": "indeterminate", "colorName": "yellow", "name": "In Progress" } }, { "self": "https://empyrajira.atlassian.net/rest/api/3/status/10002", "description": "", "iconUrl": "https://empyrajira.atlassian.net/", "name": "Done", "id": "10002", "statusCategory": { "self": "https://empyrajira.atlassian.net/rest/api/3/statuscategory/3", "id": 3, "key": "done", "colorName": "green", "name": "Done" } } ] } ]
FIELD: PERMISSION SCHEME
{ "expand": "permissions,user,group,projectRole,field,all", "id": 0, "self": "https://empyrajira.atlassian.net/rest/api/3/permissionscheme/0", "name": "Default Permission Scheme", "description": "This is the default Permission Scheme. Any new projects that are created will be assigned this scheme." }
FIELD: NOTIFICATION SCHEME
{ "expand": "notificationSchemeEvents,user,group,projectRole,field,all", "id": 10604, "self": "https://empyrajira.atlassian.net/rest/api/3/notificationscheme/10604", "name": "(AP) Notification Scheme", "description": "" }
, multiple selections available,
Related content
20.Groovy Scripts (Cloud and Server) & Learning
20.Groovy Scripts (Cloud and Server) & Learning
Read with this
60.Slack Documentation
60.Slack Documentation
Read with this
90. Bitbucket migration automation script
90. Bitbucket migration automation script
Read with this
Cloud App Development
Cloud App Development
Read with this
40.Exploration : Status Page
40.Exploration : Status Page
Read with this