Bienvenue sur le HelpDesk de Keepeek

Articles dans cette section

Afficher plus

Boards

boards

This relation targets the collection of boards the authenticated user can see.

4.31.0+

board

This relation targets the canonical representation of a board.

4.31.0+

Create a board

POST - http://baobab.keepeek.com/api/dam/boards
{
    "title": "Titre test 4",
    "description": "Description",
    "tags": [
        "valentin",
        "b"
    ],
    "status": "ACTIVATED",
    "deactivationDate": "2023-08-24T00:00:00Z"
}

When the board is created then a http response status201 is thrown. The location of the created board is in Location HTTP header of the response. If the title attribute is not filled the the board will be created with a default title. Possible values for status attribute are : ACTIVATED and DEACTIVATED.

Possible errors are :

  • 401 user give bad credentials
  • 403 user has not access to board feature
  • 500 internal server error

4.95.0

Duplicate a bord from an existing one

POST - http://baobab.keepeek.com/api/dam/boards?duplicateStakeholders=true
{
  "_links": {
    "kpk:duplicate-from": {
      "href": "http://baobab.keepeek.com/api/dam/boards/78"
    }
  }
}

When the board is created then a http response status201 is thrown. The location of the created board is in Location HTTP header of the response. If the title attribute is not filled the the board will be created with a default title. You can add any of board creation attribute to the request payload to override the value of the source board, for example to override the description :

POST - http://baobab.keepeek.com/api/dam/boards?duplicateStakeholders=true
{
  "description": "overriden description",
  "_links": {
    "kpk:duplicate-from": {
      "href": "http://baobab.keepeek.com:8888/api/dam/boards/78"
    }
  }
}

You can duplicate board stack holder by setting the duplicateStakeholders flag to true.

Possible errors are :

  • 401 user gave bad credentials
  • 403 user has not access to board feature
  • 404 the source board can not be found
  • 500 internal server error

4.95.0

Get a board

GET - http://baobab.keepeek.com/api/dam/boards/78

{
    "id": 78,
    "title": "Titre test 1",
    "description": "Description",
    "tags": [
        "tag1"
    ],
    "status": "ACTIVATED",
    "creationDate": "2023-08-09T14:16:31.000Z",
    "creationUserId": 21,
    "_links": {
        "self": {
            "href": "http://baobab.keepeek.com/api/dam/boards/78"
        },
        "curies": [
            {
                "name": "kpk",
                "href": "http://baobab.keepeek.com/api/doc/rels/{rel}",
                "templated": true
            }
        ],
        "kpk:columns": {
            "href": "http://baobab.keepeek.com/api/dam/boards/78/columns"
        },
        "kpk:users": {
            "href": "http://baobab.keepeek.com/api/dam/boards/13/users"
        }
    }
}

Possible errors are :

  • 401 user gave bad credentials
  • 403 user has not access to board feature
  • 404 the board can not be found
  • 500 internal server error

4.95.0

Update a board

PUT - http://baobab.keepeek.com/api/dam/boards/78

{
    "title": "Titre modifié",
    "description": "Description modifiée",
    "tags": [
        "tag1",
        "tag2"
    ],
    "status": "ACTIVATED",
    "deactivationDate": "2023-08-23T22:00:00.000Z"
}

Expected result is 204.

As it is a PUT request, all fields that are not filled will be deleted from the board attributes. The title attribute of a board is mandatory, so you will get an error 400 if the title attribute is not filled.

Possible errors are :

  • 400 - field-title-required-in-body : the title is not filled in the request payload
  • 401 : user is not authenticated
  • 403 - board-access-forbidden : the user has no access to the board
  • 404 - board-not-found : the board does not exist
  • 500: unknown error

4.95.0

Delete a board

DELETE - http://baobab.keepeek.com/api/dam/boards/78

Expected result is 204.

The manager can delete a board only if he is the last manager of the board, otherwise it will get a 403 response.

Possible errors are :

  • 401 : User is not authenticated
  • 403 - board-deletion-forbidden : the user has no right to delete the board
  • 403 - board-deletion-forbidden-not-last-manager : the user is not the last manager of the board
  • 500: unknown error

Get the collaborative users of a board

You can get all the collaborative users of a board.

GET - http://baobab.keepeek.com/api/dam/boards/78/users

Expected result is 200.

{
  "users": [
    {
      "id": 159,
      "fullName": "test1",
      "email": "test1@keepeek.com",
      "permission": "contribute",
      "isGuest": false,
      "columns": [
        {
          "id": 9,
          "_links": {
            "self": {
              "href": "http://baobab.keepeek.com/api/dam/boards/11/columns/9"
            }
          }
        }
      ],
      "_links": {
        "self": {
          "href": "http://baobab.keepeek.com/api/dam/users/159"
        },
        "kpk:user-url": {
          "href": "http://baobab.keepeek.com/#/boards/edit?id=11"
        }
      }
    },
    {
      "id": 460,
      "fullName": "maxime Hamon",
      "email": "maxime@hamon.fun",
      "permission": "contribute",
      "isGuest": true,
      "columns": [
        {
          "id": 11,
          "_links": {
            "self": {
              "href": "http://baobab.keepeek.com/api/dam/boards/11/columns/11"
            }
          }
        },
        {
          "id": 9,
          "_links": {
            "self": {
              "href": "http://baobab.keepeek.com/api/dam/boards/11/columns/9"
            }
          }
        },
        {
          "id": 10,
          "_links": {
            "self": {
              "href": "http://baobab.keepeek.com/api/dam/boards/11/columns/10"
            }
          }
        }
      ],
      "_links": {
        "self": {
          "href": "http://baobab.keepeek.com/api/dam/users/460"
        },
        "kpk:user-url": {
          "href": "http://baobab.keepeek.com/eolaIGZ9vl"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "http://baobab.keepeek.com/api/dam/boards/11/users"
    },
    "curies": [
      {
        "name": "kpk",
        "href": "http://baobab.keepeek.com/api/doc/rels/{rel}",
        "templated": true
      }
    ]
  }
}

Possible errors are :

  • 401 user gave bad credentials
  • 403 user has not access to collaborative users of the board
  • 404 the board can not be found
  • 500 internal server error

4.95.0

Articles associés