{"type":"doc","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"beta","localId":"53cb4896-25f9-46ef-8a44-70f298febd16"}},{"text":" ","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"3"}},"macroMetadata":{"macroId":{"value":"6d2061ea5ff7bfbf644c0fd636a0dcdb"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"cd67853f-66e6-4a84-9f08-9f4e6a1afec5"}},{"type":"paragraph","content":[{"text":"This is the \"Excel-like Tables for Jira\" REST API.","type":"text"}]},{"type":"paragraph","content":[{"text":"The API uses Basic auth as the same as ","type":"text"},{"text":"Jira REST API's Basic auth","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"The method allows you to authenticate with the Jira user's account and its ","type":"text"},{"text":"API token","type":"text","marks":[{"type":"link","attrs":{"href":"https://confluence.atlassian.com/x/Vo71Nw"}}]},{"text":".","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Common","type":"text"}]},{"type":"paragraph","content":[{"text":"Base URL","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"https://excel-like-tables-for-jira.herokuapp.com","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Content type","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"text":"application/json","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"get","localId":"db39d17e-5f62-4973-bd61-1c1fdda7f800"}},{"text":" /rest/api/table/meta/{issueKey}","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieve the meta-information of a table on the issue.","type":"text"}]},{"type":"paragraph","content":[{"text":"If the issue doesn't have a table, return 404.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"It will take some time from receiving an issue-create an event to attaching a table. Using this API allows you to confirm the completion of attaching a table.","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path Parameters","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"issueKey","type":"text","marks":[{"type":"strong"}]},{"text":": Jira issue key","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Query Parameters","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"strong"}]},{"text":": Jira hostname (e.g., ","type":"text"},{"text":"xxxx.atlassian.net","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"200","localId":"a433c20a-afa1-488c-8c2b-34939896946a"}},{"text":" OK","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"404","localId":"d0aa3d4f-11fb-44ff-bf5f-a744fda7c1dc"}},{"text":" Not Found","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"get","localId":"a0f15ff7-76c6-4264-ade1-12e000284a44"}},{"text":" /rest/api/table/{issueKey}","type":"text"}]},{"type":"paragraph","content":[{"text":"Retrieve the table data on the issue.","type":"text"}]},{"type":"paragraph","content":[{"text":"The data is base on the JSON format defined ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.mescius.com/spreadjs/docs/features/jsonschema/fullschema"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path Parameters","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"issueKey","type":"text","marks":[{"type":"strong"}]},{"text":": Jira issue key","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Query Parameters","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"strong"}]},{"text":": Jira hostname (e.g., ","type":"text"},{"text":"xxxx.atlassian.net","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"version","type":"text","marks":[{"type":"strong"}]},{"text":": (optional) version number of the table","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"200","localId":"34a54b42-e09b-4fca-b1c9-eaa8c91b34fc"}},{"text":" OK","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"400","localId":"fc13cad8-bb64-4523-b5bc-8fd76b3e76b6"}},{"text":" Bad Request","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"404","localId":"65b10669-ce8f-4a58-904e-b4bc93819d41"}},{"text":" Not Found","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"put","localId":"1cc7db1e-d71b-43c1-a369-204a33a06f8b"}},{"text":" /rest/api/table/{issueKey}","type":"text"}]},{"type":"paragraph","content":[{"text":"Set given data to the table on the issue.","type":"text"}]},{"type":"paragraph","content":[{"text":"The data is base on the JSON format defined ","type":"text"},{"text":"here","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.mescius.com/spreadjs/docs/features/jsonschema/fullschema"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Path Parameters","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"issueKey","type":"text","marks":[{"type":"strong"}]},{"text":": Jira issue key","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Query Parameters","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"host","type":"text","marks":[{"type":"strong"}]},{"text":": Jira hostname (e.g., ","type":"text"},{"text":"xxxx.atlassian.net","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request Body","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"JSON data that describes a table","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Response","type":"text","marks":[{"type":"textColor","attrs":{"color":"#97a0af"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"200","localId":"0527143e-7e6d-4931-998d-422e1340874e"}},{"text":" OK","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"400","localId":"25536316-5443-48b4-b13f-9990ebb74405"}},{"text":" Bad Request","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"404","localId":"d1d05296-3f3b-4a80-94c4-7cb4bb5bf6e6"}},{"text":" Not Found","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Examples","type":"text"}]},{"type":"paragraph","content":[{"text":"This example copies the table to another Jira issue.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n \n\n\n

\n\n\n","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported