Encuentre un Tablero(s), según el valor de coincidencia de palabra clave de la cadena de consulta pasada.
La cuenta de la API REST debe tener el permiso de visualizador correcto para que el tablero se incluya como parte de los resultados devueltos
HTTP
GET https://organisation.fluid.work/rest/api/board/find
Curl
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/board/?query=SampleKeyword
con parámetros opcionales
HTTP
GET https://organisation.fluid.work/rest/api/board/find/?query=SampleKeyword&fields={fields}&expand={expand}&version=3.0
Curl
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/board/find?query=SampleKeyword&fields=all&expand=all'
Parámetros de URL
|
Nombre |
En |
Requerido |
Tipo |
Descripción |
|
query |
path |
true |
string |
La palabra clave utilizada para buscar una coincidencia con el Título y la Descripción de un Tablero |
|
fields |
query |
false |
string |
Lista separada por comas de los campos solicitados |
|
expand |
query |
false |
string |
Parámetro de expansión para los atributos del Tablero. Las opciones posibles son{"none" "all" "method" "related" "chat" "state"} |
|
version |
query |
false |
string |
Versión de la API que se utilizará. Si no se establece, se usará la versión más reciente predeterminada. |
Respuesta
|
Nombre |
Tipo |
Descripción |
|
200 OK |
Action |
operación exitosa |
|
400 |
string |
Solicitud incorrecta |
|
404 |
string |
"Tablero No encontrado para {query}" |
|
429 |
string |
"Demasiadas solicitudes" consulte los encabezados de respuesta RateLimit-Limit (capacidad actual del límite de tasa), RateLimit-Remaining (tokens restantes), RateLimit-Reset (tiempo hasta la próxima renovación) |
Encabezados de respuesta
|
Nombre |
Tipo |
Descripción |
|
RateLimit-Limit |
string |
Límite máximo de solicitudes permitidas |
|
RateLimit-Remaining |
string |
Capacidad restante de solicitudes permitidas |
|
RateLimit-Reset |
string |
Próxima fecha y hora para la renovación de la capacidad |
Ejemplo de solicitud GET
cUrl
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/board/find/?query=Sample'
Respuesta de ejemplo
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": "Sample",
"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": "Sample",
"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": "Sample",
"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": null,
"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"
},
{
"fields": {
"active": false,
"boardCategory": 0,
"boardType": "Kanban",
"cancelledState": "Cancelled",
"cardType": [
{
"cardType": "Bug",
"colourHexValue": "#dc0a34",
"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": "af1a955e-96cd-429e-a092-05f9d32509bb",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "4435c917-de92-4df0-8d71-8381ace82c3a",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "9c285d16-7fc2-41fa-ab76-060d3fd4bcb7",
"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,
"membersOnly": false,
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00.0000000",
"name": "Sample 2",
"notStartedState": "Not Started",
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"subBoards": [
{
"guid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"id": 0,
"context": {
"name": "Sample 2",
"score": 0.0,
"type": "Board",
"externalReference": "",
"email": null,
"shortCode": "DT",
"isPrivate": false,
"isConnection": true,
"isCatalog": false,
"catalogType": null,
"avatarUrl": "/Content/images/logos/Board.svg",
"emailOptIn": true,
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"id": 710,
"referenceId": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"active": false
},
"targetGuid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"title": "Sample 2",
"startDate": "2024-06-10T16:53:54.0000000",
"status": "Not Started",
"modified": 0.0,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"created": "2024-06-10T16:53:54.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"comments": 0,
"taskCount": 0,
"boardType": null,
"boardCategory": 0,
"velocity": 0.0,
"isClosed": false
}
],
"taskCount": null
},
"id": 710,
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"url": "https://organisation.fluid.work/rest/api/board/710"
}
]
Ejemplo de solicitud GET con la opción expand
cUrl
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/board/find/?query=Sample?expand=all'
Respuesta de ejemplo
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,
"mailToAddress": "630@dev-tmpblank.app.fluid.work",
"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": "Sample",
"notStartedState": "Not Started",
"openSprints": 0,
"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": "Sample",
"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": "Sample",
"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.00,
"isClosed": false
}
],
"taskCount": null,
"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"
},
{
"fields": {
"active": false,
"boardCategory": 0,
"boardType": "Kanban",
"cancelledState": "Cancelled",
"cardType": [
{
"cardType": "Bug",
"colourHexValue": "#dc0a34",
"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": "af1a955e-96cd-429e-a092-05f9d32509bb",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "4435c917-de92-4df0-8d71-8381ace82c3a",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "9c285d16-7fc2-41fa-ab76-060d3fd4bcb7",
"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,
"mailToAddress": "710@dev-tmpblank.app.fluid.work",
"membersOnly": false,
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00.0000000",
"name": "Sample 2",
"notStartedState": "Not Started",
"openSprints": 0,
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"subBoards": [
{
"guid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"id": 0,
"context": {
"name": "Sample 2",
"score": 0.0,
"type": "Board",
"externalReference": "",
"email": null,
"shortCode": "DT",
"isPrivate": false,
"isConnection": true,
"isCatalog": false,
"catalogType": null,
"avatarUrl": "/Content/images/logos/Board.svg",
"emailOptIn": true,
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"id": 710,
"referenceId": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"active": false
},
"targetGuid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"title": "Sample 2",
"startDate": "2024-06-10T16:53:54.0000000",
"status": "Not Started",
"modified": 0.0,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"created": "2024-06-10T16:53:54.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"comments": 0,
"taskCount": 0,
"boardType": null,
"boardCategory": 0,
"velocity": 0.00,
"isClosed": false
}
],
"taskCount": null
},
"id": 710,
"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": "Status changed from In Progress to Not Started by @DavidBurt",
"topicId": 22733,
"display": "Status changed from In Progress 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-10T16:59:20.0000000"
},
{
"id": 0,
"content": "Status changed from Not Started to In Progress by @DavidBurt",
"topicId": 22732,
"display": "Status changed from Not Started to In Progress 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-10T16:59:16.0000000"
}
],
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"url": "https://organisation.fluid.work/rest/api/board/710"
}
]
Ejemplo de solicitud POST con objeto Find y opción expand
El objeto payload de la solicitud POST incluye parámetros de búsqueda adicionales que se pueden usar para refinar aún más la respuesta del resultado.
-
query - El valor que se desea buscar.
-
filters - Lista de campos y valores que desea que coincidan e incluir únicamente como parte del resultado.
-
orderBy - Lista de campos y orden de clasificación por los que desea ordenar los resultados. (ASC - Ascendente, DESC - Descendente)
cUrl
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/board/find/?expand=all'
--header 'Content-Type: application/json' \
--data '{
"query": "sample",
"filters": [
{
"field": "fields.owners.username",
"value": "david.burt"
}
],
"orderBy": [
{
"field": "Fields.Name",
"sortOrder": "Asc"
}
]
}
}'
Respuesta de ejemplo
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,
"mailToAddress": "630@dev-tmpblank.app.fluid.work",
"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": "Sample",
"notStartedState": "Not Started",
"openSprints": 0,
"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": "Sample",
"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": "Sample",
"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.00,
"isClosed": false
}
],
"taskCount": null,
"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"
},
{
"fields": {
"active": false,
"boardCategory": 0,
"boardType": "Kanban",
"cancelledState": "Cancelled",
"cardType": [
{
"cardType": "Bug",
"colourHexValue": "#dc0a34",
"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": "af1a955e-96cd-429e-a092-05f9d32509bb",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "4435c917-de92-4df0-8d71-8381ace82c3a",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "9c285d16-7fc2-41fa-ab76-060d3fd4bcb7",
"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,
"mailToAddress": "710@dev-tmpblank.app.fluid.work",
"membersOnly": false,
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00.0000000",
"name": "Sample 2",
"notStartedState": "Not Started",
"openSprints": 0,
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"subBoards": [
{
"guid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"id": 0,
"context": {
"name": "Sample 2",
"score": 0.0,
"type": "Board",
"externalReference": "",
"email": null,
"shortCode": "DT",
"isPrivate": false,
"isConnection": true,
"isCatalog": false,
"catalogType": null,
"avatarUrl": "/Content/images/logos/Board.svg",
"emailOptIn": true,
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"id": 710,
"referenceId": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"active": false
},
"targetGuid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"title": "Sample 2",
"startDate": "2024-06-10T16:53:54.0000000",
"status": "Not Started",
"modified": 0.0,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"created": "2024-06-10T16:53:54.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"comments": 0,
"taskCount": 0,
"boardType": null,
"boardCategory": 0,
"velocity": 0.00,
"isClosed": false
}
],
"taskCount": null
},
"id": 710,
"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": "Status changed from In Progress to Not Started by @DavidBurt",
"topicId": 22733,
"display": "Status changed from In Progress 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-10T16:59:20.0000000"
},
{
"id": 0,
"content": "Status changed from Not Started to In Progress by @DavidBurt",
"topicId": 22732,
"display": "Status changed from Not Started to In Progress 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-10T16:59:16.0000000"
}
],
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"url": "https://organisation.fluid.work/rest/api/board/710"
}
]
Definiciones
|
Nombre |
Descripción |
|
id |
El entero Id identifica de forma exclusiva a este Tablero en particular, puede intercambiarse con guid, ver más abajo |
|
guid |
La cadena guid, identifica de forma exclusiva a este Tablero en particular, puede intercambiarse con id, ver arriba |
|
url |
La URL REST GET para este Tablero |
|
fields |
Mapa de campos y valores para el 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 al tablero |
|
owners[] |
Describe una lista de usuarios a los que pertenece 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 las columnas del Tablero |
|
subBoards[] |
Si se trata de un espacio de trabajo de Tablero, lista de subtableros asociados a este espacio de trabajo; los subtableros comparten la misma configuración del espacio de trabajo del tablero, como columnas y cardTypes, etc |
ModifiedBy
|
Nombre |
Descripción |
|
id |
El entero Id identifica de forma exclusiva a este Usuario en particular, puede intercambiarse con guid, ver más abajo |
|
guid |
La cadena guid, identifica de forma exclusiva a este Usuario en particular, puede intercambiarse con id, ver arriba |
|
name |
El nombre completo de este Usuario |
|
username |
El nombre de usuario asociado a este Usuario |
|
|
Correo electrónico único asociado a este Usuario |
Members[]
|
Nombre |
Descripción |
|
id |
El entero Id identifica de forma exclusiva a este Usuario en particular, puede intercambiarse con guid, ver más abajo |
|
guid |
La cadena guid, identifica de forma exclusiva a este Usuario en particular, puede intercambiarse con id, ver arriba |
|
name |
El nombre completo de este Usuario |
|
username |
El nombre de usuario asociado a este Usuario |
|
|
Correo electrónico único asociado a este Usuario |
Owners[]
|
Nombre |
Descripción |
|
id |
El entero Id identifica de forma exclusiva a este Usuario en particular, puede intercambiarse con guid, ver más abajo |
|
guid |
La cadena guid, identifica de forma exclusiva a este Usuario en particular, puede intercambiarse con id, ver arriba |
|
name |
El nombre completo de este Usuario |
|
username |
El nombre de usuario asociado a este Usuario |
|
|
Correo electrónico único asociado a este Usuario |
Viewers[]
|
Nombre |
Descripción |
|
id |
El entero Id identifica de forma exclusiva a este Usuario en particular, puede intercambiarse con guid, ver más abajo |
|
guid |
La cadena guid, identifica de forma exclusiva a este Usuario en particular, puede intercambiarse con id, ver arriba |
|
name |
El nombre completo de este Usuario |
|
username |
El nombre de usuario asociado a este Usuario |
|
|
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 diálogo de creación de tareas/tarjetas |
|
isDefault |
Tarea/tarjeta predeterminada seleccionada al crear, tal como se muestra en el diálogo de creación |
Columns[]
|
Nombre |
Descripción |
|
id |
La cadena guid, identifica de forma exclusiva a esta columna en particular |
|
title |
El título de esta columna |
|
state |
estado/status de esta columna; cualquier tarjeta en esta columna tendrá este estado/status aplicado |
|
slaDays |
|
|
complete |
¿Es esta columna una columna de estado/status completado? |
|
rating |
valor entero de calificación que se aplicará en esta columna |
|
order |
orden de posición de izquierda a derecha de esta columna |
SubBoards[]
|
Nombre |
Descripción |
|
id |
El entero Id, identifica de forma exclusiva a este Tablero en particular, puede intercambiarse con guid, ver más abajo |
|
guid |
La cadena guid, identifica de forma exclusiva a este Tablero en particular, puede intercambiarse con id, ver 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