core-documentation

Figures

• List figures
• Get a single figure
• Create a figure
• Update a figure
• Delete a figure

List figures

GET /console/comp/figures

Auth

• “editor”

Paging

YES

Available query parameters

Key	Type	Description	Match	Example
title	string	用標題過濾圖表	partial	法 法條

Response

{
  rows: [
    {
      id
      status
      type
      title
      data_set: {
        id
        name
        type
        st: {
          id
          title
          image
          index
        }
      }
    }
    ...
  ]
  totalRowCount
  paging: {
    pages
    pageSize
    previous
    next
    page
  }
}

Get a single figure

GET /console/comp/figure/:id

Auth

• “editor”

Paging

NO

Response

{
  id
  status
  slug
  type
  image
  title
  description
  summary
  data_set_type
  data_set_id
}

Create a figure

POST /console/comp/figure

Auth

• “editor”

Paging

NO

Input

Key	Type	Required	Description
status	string	🌕	狀態
slug	string	🌕	短網址
type	string	🌕	類型
image	string	🌕	圖像的路徑
title	string	🌕	標題
description	string	🌑	敘述
summary	string	🌑	摘要
data_set_type	string	🌕	資料集型別
data_set_id	integer	🌕	資料集 ID

Sample input

{
  "status": "active",
  "slug": "bill-comp/recall/xxxx",
  "type": "histogram",
  "image": "path/image.png",
  "title": "法條比一比",
  "description": "在提案連署過程中⋯",
  "summary": "能否讓罷免順利成功⋯",
  "data_set_type": "LAB_Bill_Data_Set",
  "data_set_id": 1,
}

Response

Returns the newly created figure

Update a figure

PATCH /console/comp/figure/:id

Auth

• “editor”

Paging

NO

參考 Create a figure

Delete a figure

DELETE /console/comp/figure/:id

Auth

• “editor”

Paging

NO

Response

204 No Content