Java API: Examples and definitions

Learn about the Bundled Fields’ JSON structure and its attributes

Bundled Fields’ structure

Here is what an examplary Bundled Fields custom field looks like in the context of:

• Jira Issue View

  

• Configuration screen within the Bundled Fields app

  

• Jira REST API

  

• Java API (ScriptRunner)

  

• JSON format of the field

{
   "configurationId":3,
   "baseGroupId":{
      "fields":[
         {
            "id":"75355903-7c50-4298-a57b-8119e4350a57",
            "originId":"75355903-7c50-4298-a57b-8119e4350a57",
            "value":"text value 1"
         },
         {
            "id":"f617ff8d-4da1-4460-a7ba-19d45287de6e",
            "originId":"f617ff8d-4da1-4460-a7ba-19d45287de6e",
            "value":"text value 2"
         },
         {
            "id":"e3504c9d-ae95-4a6f-9e1e-43ad1897abf8",
            "originId":"e3504c9d-ae95-4a6f-9e1e-43ad1897abf8",
            "value":"86daf9e6-ac14-484a-b858-00fcc2a3e123"
         },
         {
            "id":"d503e309-1087-428a-8c1b-4da10c1b66be",
            "originId":"d503e309-1087-428a-8c1b-4da10c1b66be",
            "value":"33a885fa-9ee4-4e7f-8c84-84d7929544d5"
         },
         {
            "id":"d69d220a-bb32-46a4-9391-dbbd9d8eff26",
            "originId":"d69d220a-bb32-46a4-9391-dbbd9d8eff26",
            "value":"2021-01-11T23:00:00.000Z"
         },
         {
            "id":"ee8be8b3-1745-425b-9bcf-86c16c37a2bb",
            "originId":"ee8be8b3-1745-425b-9bcf-86c16c37a2bb",
            "value":"2021-01-12T11:06:00.000Z"
         },
         {
            "id":"9faa1c9f-25d1-451b-8002-819be057b56f",
            "originId":"9faa1c9f-25d1-451b-8002-819be057b56f",
            "value":"2021-01-11T13:18:00.000Z"
         },
         {
            "id":"3b328579-b57c-4aca-9451-e3019e95ffdb",
            "originId":"3b328579-b57c-4aca-9451-e3019e95ffdb",
            "value":"Multiline Text Value 1"
         }
      ],
      "order":0
   },
   "b1fcbf4e-a243-45ce-afe9-a6e8b401c41d":{
      "fields":[
         {
            "id":"a14aebf9-87da-4442-b4a3-0b5239ad2698",
            "originId":"75355903-7c50-4298-a57b-8119e4350a57",
            "value":"another text value 1"
         },
         {
            "id":"3c89db7b-192e-451b-aac8-7862e0cc3d68",
            "originId":"f617ff8d-4da1-4460-a7ba-19d45287de6e",
            "value":"another text value 2"
         },
         {
            "id":"81018e91-88c5-4cf7-b688-a5090503884b",
            "originId":"e3504c9d-ae95-4a6f-9e1e-43ad1897abf8",
            "value":"70605cff-5c64-4bc2-888d-02a268af2b7d"
         },
         {
            "id":"bc033644-4940-495b-bdc3-0f8b5b9d80bb",
            "originId":"d503e309-1087-428a-8c1b-4da10c1b66be",
            "value":"d83d4de4-8b46-418c-9984-a400fc331230,976f342a-232b-4128-877f-a7ce2563a075"
         },
         {
            "id":"84a026d6-eeda-43f0-8d1e-c54be1db6eb7",
            "originId":"d69d220a-bb32-46a4-9391-dbbd9d8eff26",
            "value":"2021-01-26T23:00:00.000Z"
         },
         {
            "id":"d2791a87-be7c-47fc-9a92-faa63cda1dbe",
            "originId":"ee8be8b3-1745-425b-9bcf-86c16c37a2bb",
            "value":"2021-01-20T12:56:00.000Z"
         },
         {
            "id":"bbb8a49a-b1ec-4e82-9565-7caf6005179b",
            "originId":"9faa1c9f-25d1-451b-8002-819be057b56f",
            "value":"2021-01-11T12:34:00.000Z"
         },
         {
            "id":"9c5c106b-1287-467f-a769-af7943f1d1a5",
            "originId":"3b328579-b57c-4aca-9451-e3019e95ffdb",
            "value":"Another Multiline Text Value 1"
         }
      ],
      "order":1
   }
}

Definitions

• configurationId: ID of a specific configuration of a Bundled Fields custom field (table AO_8CB340_DF_BUNDLED_CFG)
• baseGroupId: Predefined name of the first group’s key. Every next key name is generated by the system (just as the key b1fcbf4e-a243-45ce-afe9-a6e8b401c41d in the example below)

{
   "configurationId":3,
   "baseGroupId":{
      "fields":[
         
      ],
      "order":0
   },
   "b1fcbf4e-a243-45ce-afe9-a6e8b401c41d":{
      "fields":[
         
      ],
      "order":1
   }
}

• order: Sequence number of the group on the issue view
• fields: Set of subfields’ values in a given group
• id: Key (ID) of a subfield value
• originId: Key (ID) of a subfield value configuration
• value: Value of a subfield. If it’s a text or a date then a specific value will be given. If it’s a select list or a checkbox the value will be represented by comma-separated keys (IDs) of the given subfield’s configuration, for example:

"value":"d83d4de4-8b46-418c-9984-a400fc331230,976f342a-232b-4128-877f-a7ce2563a075"