Create, Query and Delete Card

Updated at:

You can call the card APIs to create, query, and delete cards.

Create a card

  • Request path: /openapi/cubecard/createTemplate

  • Request method: POST

  • Request parameters

    Name

    Type

    Required

    Description

    templateId

    String

    Yes

    The card ID.

    templateName

    String

    Yes

    The card name.

    templateDesc

    String

    No

    The description of the card.

  • Return value

    success

Query card list

  • Request path: /openapi/cubecard/listTemplates

  • Request method: GET

  • Request parameters

    Name

    Type

    Required

    Description

    pageNum

    Integer

    Yes

    The current page number. Pages start from 1.

    pageSize

    Integer

    No

    The number of items per page. Default value: 20.

  • Return value

    {
      "firstPage":true,
      "lastPage":true,
      "nextPage":1,
      "pageNo":1,
      "pageSize":20,
      "prePage":1,
      "totalCount":7,
      "totalPage":1,
      "list":[
        {
          "id":123, // The primary key
          "templateName":"Card name",
          "templateId":"Card ID",
          "templateDesc":"Card description"
        }
      ]
    }

    Return value description

    Parameter

    Type

    Description

    firstPage

    boolean

    Indicates whether the current page is the first page.

    • Yes: true

    • No: false

    lastPage

    boolean

    Indicates whether the current page is the last page.

    • Yes: true

    • No: false

    nextPage

    Integer

    The page number of the next page.

    pageNo

    Integer

    The current page number.

    pageSize

    Integer

    The number of items returned per page.

    prePage

    Integer

    The page number of the previous page.

    totalCount

    Integer

    The total number of cards.

    totalPage

    Integer

    The total number of pages.

    list

    List

    The list of cards returned. The following table describes the fields in each entry.

    id

    Long

    The primary key of the card.

    templateName

    String

    The name of the card.

    templateId

    String

    The card ID.

    templateDesc

    String

    The description of the card.

Delete a card

  • Request path: /openapi/cubecard/deleteTemplate

  • Request method: POST

  • Request parameters

    Name

    Type

    Required

    Description

    templateId

    String

    Yes

    The card ID.

  • Return value

    Deleted successfully