Boards

Obtener tablero

Dan Justin

Devuelve un único Tablero según el id o GUID especificado, pasado como parte de la consulta.

El usuario de la API REST debe contar con los permisos correctos.


HTTP

GET https://organisation.fluid.work/rest/api/board/{id}/

Curl

curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/board/663'


con parámetros opcionales

HTTP

GET https://organisation.fluid.work/rest/api/board/{id}/?fields={fields}&expand={expand}&version=3.0

Curl

curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/board/663?fields=all&expand=all'

Parámetros de URL

Nombre

En

Requerido

Tipo

Descripción

id

path

true

Texto

El id del Tablero puede ser un valor numérico en formato de texto ### o una cadena guid; ambos son identificadores únicos para este Tablero y pueden usarse indistintamente.

fields

query

false

Texto

Lista de campos solicitados separados por comas

expand

query

false

Texto

Parámetro expand para los atributos del Tablero. Las opciones posibles son{"none" "all" "method" "related" "chat" "state"}

version

query

false

Texto

Versión de la API a utilizar. Si no se establece, se utilizará la última versión de forma predeterminada.


Respuesta

Nombre

Tipo

Descripción

200 OK

Action

operación exitosa

400

Texto

Solicitud incorrecta

404

Texto

"Board Not Found for {id}"

429

Texto

"Too many Requests" consulte los encabezados de respuesta RateLimit-Limit (capacidad actual del límite de solicitudes), RateLimit-Remaining (tokens restantes), RateLimit-Reset (tiempo hasta el próximo reinicio)

Encabezados de respuesta

Nombre

Tipo

Descripción

RateLimit-Limit 

Texto

Límite máximo de solicitudes permitidas 

RateLimit-Remaining 

Texto

Capacidad restante de solicitudes permitidas 

RateLimit-Reset 

Texto

Próxima fecha y hora de restablecimiento de la capacidad 


Solicitud de muestra GET

cUrl

curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/board/630'

Respuesta de muestra

Código de estado: 200

JSON

{
    "fields": {
        "active": true,
        "boardCategory": 0,
        "boardType": "Kanban",
        "cancelledState": "Cancelled",
        "cardType": [
            {
                "cardType": "Bug",
                "colourHexValue": "#dc0a34",
                "isDefault": false
            },
            {
                "cardType": "Epic",
                "colourHexValue": "#3f7cac",
                "isDefault": false
            },
            {
                "cardType": "Improvement",
                "colourHexValue": "#ae3778",
                "isDefault": false
            },
            {
                "cardType": "New Feature",
                "colourHexValue": "#f66307",
                "isDefault": false
            },
            {
                "cardType": "Production Issue",
                "colourHexValue": "#121212",
                "isDefault": false
            },
            {
                "cardType": "Task",
                "colourHexValue": "#2d60a5",
                "isDefault": true
            },
            {
                "cardType": "User Story",
                "colourHexValue": "#55917f",
                "isDefault": false
            }
        ],
        "columns": [
            {
                "id": "f02b2f90-7320-4e66-9e3f-4c342c38c901",
                "title": "Not Started",
                "state": "Not Started",
                "slaDays": 0,
                "complete": false,
                "rating": 0.0,
                "colOwners": [],
                "colTeam": [],
                "order": 0,
                "actions": [],
                "createProject": false,
                "defaultProjectStatus": ""
            },
            {
                "id": "cec38aa4-35c2-4472-8a65-b35d63b8e527",
                "title": "In Progress",
                "state": "In Progress",
                "slaDays": 0,
                "complete": false,
                "rating": 0.0,
                "colOwners": [],
                "colTeam": [],
                "order": 0,
                "actions": [],
                "createProject": false,
                "defaultProjectStatus": ""
            },
            {
                "id": "7b3d98ba-2491-4853-af32-3f74be0a0efb",
                "title": "Completed",
                "state": "Completed",
                "slaDays": 0,
                "complete": false,
                "rating": 0.0,
                "colOwners": [],
                "colTeam": [],
                "order": 0,
                "actions": [],
                "createProject": false,
                "defaultProjectStatus": ""
            }
        ],
        "completedState": "Completed",
        "created": "0001-01-01T00:00:00.0000000",
        "createdBy": null,
        "description": null,
        "epicFieldName": "Theme",
        "isPrivate": false,
        "members": [
            {
                "id": 600,
                "guid": "f8526047-c79f-4924-bcd8-c172ef38c5d8",
                "name": "Natasha Romanoff",
                "userName": "natasha.romanoff",
                "email": "natasha.romanoff@fluidbsg.com"
            }
        ],
        "membersOnly": false,
        "modifiedBy": null,
        "modifiedDate": "0001-01-01T00:00:00.0000000",
        "name": "DevOps",
        "notStartedState": "Not Started",
        "owners": [
            {
                "id": 603,
                "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                "name": "David Burt",
                "userName": "david.burt",
                "email": "dump18@fluidbsg.com"
            },
            {
                "id": 598,
                "guid": "1020642e-3e48-49aa-a693-dd8be2b7795c",
                "name": "Bruce Banner",
                "userName": "bruce.banner",
                "email": "bruce.banner@fluidbsg.com"
            },
            {
                "id": 595,
                "guid": "b0a1e7e6-2389-4cdc-8d7e-5263eb512e0d",
                "name": "Adam Jones",
                "userName": "adam.jones",
                "email": "dump7@fluidbsg.com"
            }
        ],
        "subBoards": [
            {
                "guid": "b6977faf-bcdd-4a41-8ce1-1e0abe68e55f",
                "id": 0,
                "context": {
                    "name": "DevOps",
                    "score": 0.0,
                    "type": "Board",
                    "externalReference": "",
                    "email": null,
                    "shortCode": "D",
                    "isPrivate": false,
                    "isConnection": true,
                    "isCatalog": false,
                    "catalogType": null,
                    "avatarUrl": "/Content/images/logos/Board.svg",
                    "emailOptIn": true,
                    "guid": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
                    "id": 630,
                    "referenceId": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
                    "active": true
                },
                "targetGuid": "b6977faf-bcdd-4a41-8ce1-1e0abe68e55f",
                "title": "DevOps",
                "startDate": "2022-12-19T09:54:45.0000000",
                "status": "In Progress",
                "modified": 0.0,
                "modifiedBy": {
                    "id": 603,
                    "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                    "name": "David Burt",
                    "userName": "david.burt",
                    "email": "dump18@fluidbsg.com"
                },
                "created": "2022-12-19T09:54:45.0000000",
                "createdBy": {
                    "id": 603,
                    "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                    "name": "David Burt",
                    "userName": "david.burt",
                    "email": "dump18@fluidbsg.com"
                },
                "comments": 0,
                "taskCount": 19,
                "boardType": null,
                "boardCategory": 0,
                "velocity": 0.0,
                "isClosed": false
            }
        ],
        "taskCount": 0,
        "viewers": [
            {
                "id": 582,
                "guid": "2b4609b6-299c-41b4-bd5d-1ec991e31247",
                "name": "Mike Johnson",
                "userName": "mike.johnson",
                "email": "dump11@fluidbsg.com"
            }
        ]
    },
    "id": 630,
    "guid": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
    "url": "https://organisation.fluid.work/rest/api/board/630"
}


Solicitud de muestra GET con la opción expand

cUrl

curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action/630?expand=all'

Respuesta de muestra

Código de estado: 200

JSON

{
    "fields": {
        "active": true,
        "boardCategory": 0,
        "boardType": "Kanban",
        "cancelledState": "Cancelled",
        "cardType": [
            {
                "cardType": "Bug",
                "colourHexValue": "#dc0a34",
                "isDefault": false
            },
            {
                "cardType": "Epic",
                "colourHexValue": "#3f7cac",
                "isDefault": false
            },
            {
                "cardType": "Improvement",
                "colourHexValue": "#ae3778",
                "isDefault": false
            },
            {
                "cardType": "New Feature",
                "colourHexValue": "#f66307",
                "isDefault": false
            },
            {
                "cardType": "Production Issue",
                "colourHexValue": "#121212",
                "isDefault": false
            },
            {
                "cardType": "Task",
                "colourHexValue": "#2d60a5",
                "isDefault": true
            },
            {
                "cardType": "User Story",
                "colourHexValue": "#55917f",
                "isDefault": false
            }
        ],
        "columns": [
            {
                "id": "f02b2f90-7320-4e66-9e3f-4c342c38c901",
                "title": "Not Started",
                "state": "Not Started",
                "slaDays": 0,
                "complete": false,
                "rating": 0.0,
                "colOwners": [],
                "colTeam": [],
                "order": 0,
                "actions": [],
                "createProject": false,
                "defaultProjectStatus": ""
            },
            {
                "id": "cec38aa4-35c2-4472-8a65-b35d63b8e527",
                "title": "In Progress",
                "state": "In Progress",
                "slaDays": 0,
                "complete": false,
                "rating": 0.0,
                "colOwners": [],
                "colTeam": [],
                "order": 0,
                "actions": [],
                "createProject": false,
                "defaultProjectStatus": ""
            },
            {
                "id": "7b3d98ba-2491-4853-af32-3f74be0a0efb",
                "title": "Completed",
                "state": "Completed",
                "slaDays": 0,
                "complete": false,
                "rating": 0.0,
                "colOwners": [],
                "colTeam": [],
                "order": 0,
                "actions": [],
                "createProject": false,
                "defaultProjectStatus": ""
            }
        ],
        "completedState": "Completed",
        "created": "0001-01-01T00:00:00.0000000",
        "createdBy": null,
        "description": null,
        "epicFieldName": "Theme",
        "isPrivate": false,
        "members": [
            {
                "id": 600,
                "guid": "f8526047-c79f-4924-bcd8-c172ef38c5d8",
                "name": "Natasha Romanoff",
                "userName": "natasha.romanoff",
                "email": "natasha.romanoff@fluidbsg.com"
            }
        ],
        "membersOnly": false,
        "modifiedBy": null,
        "modifiedDate": "0001-01-01T00:00:00.0000000",
        "name": "DevOps",
        "notStartedState": "Not Started",
        "owners": [
            {
                "id": 603,
                "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                "name": "David Burt",
                "userName": "david.burt",
                "email": "dump18@fluidbsg.com"
            },
            {
                "id": 598,
                "guid": "1020642e-3e48-49aa-a693-dd8be2b7795c",
                "name": "Bruce Banner",
                "userName": "bruce.banner",
                "email": "bruce.banner@fluidbsg.com"
            },
            {
                "id": 595,
                "guid": "b0a1e7e6-2389-4cdc-8d7e-5263eb512e0d",
                "name": "Adam Jones",
                "userName": "adam.jones",
                "email": "dump7@fluidbsg.com"
            }
        ],
        "subBoards": [
            {
                "guid": "b6977faf-bcdd-4a41-8ce1-1e0abe68e55f",
                "id": 0,
                "context": {
                    "name": "DevOps",
                    "score": 0.0,
                    "type": "Board",
                    "externalReference": "",
                    "email": null,
                    "shortCode": "D",
                    "isPrivate": false,
                    "isConnection": true,
                    "isCatalog": false,
                    "catalogType": null,
                    "avatarUrl": "/Content/images/logos/Board.svg",
                    "emailOptIn": true,
                    "guid": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
                    "id": 630,
                    "referenceId": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
                    "active": true
                },
                "targetGuid": "b6977faf-bcdd-4a41-8ce1-1e0abe68e55f",
                "title": "DevOps",
                "startDate": "2022-12-19T09:54:45.0000000",
                "status": "In Progress",
                "modified": 0.0,
                "modifiedBy": {
                    "id": 603,
                    "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                    "name": "David Burt",
                    "userName": "david.burt",
                    "email": "dump18@fluidbsg.com"
                },
                "created": "2022-12-19T09:54:45.0000000",
                "createdBy": {
                    "id": 603,
                    "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                    "name": "David Burt",
                    "userName": "david.burt",
                    "email": "dump18@fluidbsg.com"
                },
                "comments": 0,
                "taskCount": 19,
                "boardType": null,
                "boardCategory": 0,
                "velocity": 0.0,
                "isClosed": false
            }
        ],
        "taskCount": 0,
        "viewers": [
            {
                "id": 582,
                "guid": "2b4609b6-299c-41b4-bd5d-1ec991e31247",
                "name": "Mike Johnson",
                "userName": "mike.johnson",
                "email": "dump11@fluidbsg.com"
            }
        ]
    },
    "id": 630,
    "methods": [
        {
            "type": "Update",
            "httpMethod": "PUT",
            "url": "https://organisation.fluid.work/rest/api/board"
        },
        {
            "type": "Delete",
            "httpMethod": "DELETE",
            "url": "https://organisation.fluid.work/rest/api/board"
        }
    ],
    "chats": [
        {
            "id": 0,
            "content": "Created and set to Not Started by @DavidBurt",
            "topicId": 22751,
            "display": "Created and set to Not Started by <span class=\"atwho-inserted\"><span class=\"mention\"><span class=\"mention-thumb\"><img src=\"https://organisation.fluid.work/Principal/Initials/DB\" class=\"mention-avatar\"></span><span class=\"mention-text\">@DavidBurt</span></span></span>",
            "initiator": {
                "id": 0,
                "guid": "00000000-0000-0000-0000-000000000000",
                "name": "Dot",
                "userName": null,
                "email": "609dd11b-b587-4265-bf50-cee92a86fd42"
            },
            "timestamp": "2024-06-11T14:09:45.0000000"
        },
        {
            "id": 0,
            "content": "Successfully Updated Azure DevOps action item- 8153 by @System",
            "topicId": 22678,
            "display": "Successfully Updated Azure DevOps action item- <a href=\"https://fluidbusinesssolutions.visualstudio.com/9eb08e50-6927-4e91-a10d-1c0ab6d578d6/_workitems/edit/8153\" target=\"_blank\" rel=\"noopener noreferrer\">8153</a> by <span class=\"atwho-inserted\"><span class=\"mention\"><span class=\"mention-thumb\"><img src=\"https://organisation.fluid.work/Content/public/images/brand/icon.svg?v=1\" class=\"mention-avatar\"></span><span class=\"mention-text\">@System</span></span></span>",
            "initiator": {
                "id": 0,
                "guid": "00000000-0000-0000-0000-000000000000",
                "name": "Dot",
                "userName": null,
                "email": "609dd11b-b587-4265-bf50-cee92a86fd42"
            },
            "timestamp": "2024-06-07T16:13:02.0000000"
        }
    ],
    "guid": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
    "url": "https://organisation.fluid.work/rest/api/board/630"
}

Definiciones

Nombre

Descripción

id

El número entero Id identifica de forma única a este Tablero en particular; puede usarse indistintamente con el guid, ver más abajo

guid

La cadena guid, identifica de forma única a este Tablero en particular; puede usarse indistintamente con el id, ver más arriba

url

La URL GET de REST para este Tablero 

fields

Mapa de campos y valores del Tablero 

name

Nombre del Tablero

description

Descripción de este Tablero

mailToAddress

modifiedBy

El usuario que modificó este Tablero por última vez

membersOnly

isPrivate

El Tablero es privado

members[]

Describe una lista de usuarios que son miembros de este tablero y pueden contribuir a él

owners[]

Describe una lista de usuarios propietarios de este Tablero; los propietarios pueden actualizar la configuración del Tablero

viewers[]

Describe una lista de usuarios que tienen acceso de solo lectura al Tablero; estos usuarios no pueden contribuir al tablero.

cardType[]

Lista de tipos de tarea/tarjeta admitidos que se pueden crear en este Tablero

columns[]

Lista de columnas del Tablero

subBoards[]

Si este es un espacio de trabajo de Tablero, lista de subtableros asociados con este espacio de trabajo; los subtableros comparten la misma configuración del espacio de trabajo del tablero, como columns y cardTypes etc

ModifiedBy

Nombre

Descripción

id

El número entero Id identifica de forma única a este Usuario en particular; puede usarse indistintamente con el guid, ver más abajo

guid

La cadena guid, identifica de forma única a este Usuario en particular; puede usarse indistintamente con el id, ver más arriba

name

El nombre completo de este Usuario

username

El nombre de usuario asociado a este Usuario

email

Correo electrónico único asociado a este Usuario

Members[]

Nombre

Descripción

id

El número entero Id identifica de forma única a este Usuario en particular; puede usarse indistintamente con el guid, ver más abajo

guid

La cadena guid, identifica de forma única a este Usuario en particular; puede usarse indistintamente con el id, ver más arriba

name

El nombre completo de este Usuario

username

El nombre de usuario asociado a este Usuario

email

Correo electrónico único asociado a este Usuario

Owners[]

Nombre

Descripción

id

El número entero Id identifica de forma única a este Usuario en particular; puede usarse indistintamente con el guid, ver más abajo

guid

La cadena guid, identifica de forma única a este Usuario en particular; puede usarse indistintamente con el id, ver más arriba

name

El nombre completo de este Usuario

username

El nombre de usuario asociado a este Usuario

email

Correo electrónico único asociado a este Usuario

Viewers[]

Nombre

Descripción

id

El número entero Id identifica de forma única a este Usuario en particular; puede usarse indistintamente con el guid, ver más abajo

guid

La cadena guid, identifica de forma única a este Usuario en particular; puede usarse indistintamente con el id, ver más arriba

name

El nombre completo de este Usuario

username

El nombre de usuario asociado a este Usuario

email

Correo electrónico único asociado a este Usuario

CardType[]

Nombre

Descripción

cardType

Nombre del tipo de tarea/tarjeta que se puede crear en este Tablero

colourHexValue

Color asociado a esta tarea/tarjeta, tal como se muestra en el Tablero y en el cuadro de diálogo de creación de tarea/tarjeta

isDefault

Tarea/tarjeta predeterminada seleccionada al crear, tal como se muestra en el cuadro de diálogo de creación


Columns[]

Nombre

Descripción

id

La cadena guid, identifica de forma única a esta columna en particular

title

El título de esta columna

state

estado de esta columna; cualquier tarjeta en esta columna tendrá este estado aplicado

slaDays

complete

Indica si esta columna es una columna de estado completado

rating

valor entero de calificación que se aplica a esta columna

order

orden de posición de izquierda a derecha de esta columna

SubBoards[]

Nombre

Descripción

id

El número entero Id identifica de forma única a este Tablero en particular; puede usarse indistintamente con el guid, ver más abajo

guid

La cadena guid, identifica de forma única a este Tablero en particular; puede usarse indistintamente con el id, ver más arriba

title

status

El nombre de usuario asociado a este Usuario

modifiedBy

Correo electrónico único asociado a este Usuario

createdBy

taskCount

targetGuid


Lecturas adicionales

Was this article helpful?