{ "swagger" : "2.0", "info" : { "version" : "1", "title" : "Customfield Editor Plugin" }, "basePath" : "/jira/rest/jiracustomfieldeditorplugin/1", "tags" : [ { "name" : "admin-operations", "description" : "Admin level operations on custom fields and custom field permissions" }, { "name" : "maintenance", "description" : "Admin level maintenance endpoints" }, { "name" : "user-default-context-child-options-operations", "description" : "User level operations on custom fields with child options on default context" }, { "name" : "user-default-context-options-operations", "description" : "User level operations on custom field options for default context" }, { "name" : "user-operations", "description" : "User level operations on custom fields" }, { "name" : "user-specific-context-child-options-operations", "description" : "User level operations on custom fields with child options on specific context" }, { "name" : "user-specific-context-options-operations", "description" : "User level operations on custom field options for specific context" } ], "paths" : { "/admin/customfields" : { "get" : { "tags" : [ "admin-operations" ], "summary" : "List all customfields [c2.11.0]", "description" : "List all available customfields.\nNot all of them will be editable with the Customfield Editor Plugin. See User Guide for supported FieldTypes.\n \nDEPRECATED: When no parameters are specified the result looks like this (backwards-compatibility) and will return ALL customfields without pagination or limit: \n```\n[\n {\n \"fieldId\": 10002,\n \"fieldName\": \"my super field\",\n \"fieldType\": \"cascadingselect\",\n \"fieldDescription\": \"awesome\"\n }\n]\n```\n\n\n \nNEW: You should instead use the new approach with pagination and filtering, which will return fields wrapped inside a `values: []` array. \nThe following example was performed with these parameters `?startAt=0&maxResults=10&orderBy=fieldName`:\n```\n{\n \"maxResults\": 10,\n \"startAt\": 0,\n \"total\": 1,\n \"processingTimeInMs\": 48,\n \"values\": [\n {\n \"fieldId\": 10002,\n \"fieldName\": \"my super field\",\n \"fieldType\": \"cascadingselect\",\n \"fieldDescription\": \"awesome\",\n \"globalPermission\": {\n \"userlist\": [\n \"bob\",\n \"steve\"\n ],\n \"grouplist\": [\n \"jira-administrators\",\n \"jira-system-administrators\"\n ]\n },\n \"contextPermissions\": [\n {\n \"context\": {\n \"contextId\": 10127,\n \"contextName\": \"Defaultconfigscheme für singleselectWithContextsGuiTest\",\n \"contextDescription\": \"Von JIRA generiertes Standardkonfigurationsschema\",\n \"projects\": [],\n \"issueTypes\": []\n },\n \"userlist\": [\n \"linda\"\n ],\n \"grouplist\": []\n },\n {\n \"context\": {\n \"contextId\": 10128,\n \"contextName\": \"contextForProjectTest\",\n \"contextDescription\": \"contextForProjectTest\",\n \"projects\": [\n {\n \"projectId\": 10000,\n \"projectKey\": \"TEST\",\n \"projectName\": \"test\",\n \"projectDescription\": \"test\"\n }\n ],\n \"issueTypes\": []\n },\n \"userlist\": [\n \"chris\"\n ],\n \"grouplist\": []\n }\n ]\n }\n ]\n}\n```\n\n \n**Pagination** is handled the same way as the official JIRA REST API handles it.\n The *startAt* parameter indicates which item should be used as the first item in the page of results.\nThe *maxResults* parameter indicates how many results to return per page. The default is 20.\n*values* always contains the items and *processingTimeInMs* is the time it took to process the request in milliseconds.\n```\n{\n \"maxResults\": 20,\n \"startAt\": 100,\n \"total\": 200,\n \"processingTimeInMs\": 327,\n \"values\": [ ]\n}\n```\n \n**Ordering** is also handled in a standardized way.\nWith *?orderBy=name* the order will be ascending.\nWith *?orderBy=+name* the order will be ascending.\nWith *?orderBy=-name* the order will be descending.\n \n**Filtering** is also handled in a standardized way.\nWith *?filter=foo* the result will be filtered on the server for the value.\n \nYou need to be administrator or system administrator to use this endpoint. \n