Encontre um ou mais Boards com base no valor de correspondência de palavra-chave passado na string de consulta.
A conta da API REST precisa ter a permissão de visualizador correta para que o board seja incluído nos resultados retornados
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
com parâmetros opcionais
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
Nome | Em | Obrigatório | Tipo | Descrição |
query | path | true | string | A palavra-chave usada para encontrar uma correspondência com o Título e a Descrição de um Board |
fields | query | false | string | Lista separada por vírgulas dos campos solicitados |
expand | query | false | string | Parâmetro de expansão para atributos do Board. As opções possíveis são {"none" "all" "method" "related" "chat" "state"} |
version | query | false | string | Versão da API a ser usada. Se não definida, a versão mais recente padrão será utilizada. |
Resposta
Nome | Tipo | Descrição |
200 OK | Action | operação bem-sucedida |
400 | string | Requisição Inválida |
404 | string | "Board Não Encontrado para {query}" |
429 | string | "Muitas Requisições" veja os cabeçalhos de resposta RateLimit-Limit (capacidade atual do limite de taxa), RateLimit-Remaining (tokens restantes), RateLimit-Reset (tempo até a próxima recarga) |
Cabeçalhos de Resposta
Nome | Tipo | Descrição |
RateLimit-Limit | string | Limite máximo de taxa de requisições permitidas |
RateLimit-Remaining | string | Capacidade restante de requisições permitidas |
RateLimit-Reset | string | Próxima data e hora para recarga da capacidade |
Exemplo de Requisição GET
cUrl
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/board/find/?query=Sample'Exemplo de Resposta
Código de status: 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"
}
]Obter Solicitação de Amostra com a opção Expandir
cUrl
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/board/find/?query=Sample?expand=all'Resposta de Amostra
Código de status: 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": "Não Iniciado",
"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": "Em Andamento",
"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": "Concluído",
"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": "Criado e definido como Não Iniciado por @DavidBurt",
"topicId": 22751,
"display": "Criado e definido como Não Iniciado por <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": "Item de ação do Azure DevOps atualizado com sucesso - 8153 por @System",
"topicId": 22678,
"display": "Item de ação do Azure DevOps atualizado com sucesso - <a href=\"https://fluidbusinesssolutions.visualstudio.com/9eb08e50-6927-4e91-a10d-1c0ab6d578d6/_workitems/edit/8153\" target=\"_blank\" rel=\"noopener noreferrer\">8153</a> por <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": "Não Iniciado",
"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": "Em Andamento",
"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": "Concluído",
"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 alterado de Em Andamento para Não Iniciado por @DavidBurt",
"topicId": 22733,
"display": "Status alterado de Em Andamento para Não Iniciado por <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 alterado de Não Iniciado para Em Andamento por @DavidBurt",
"topicId": 22732,
"display": "Status alterado de Não Iniciado para Em Andamento por <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"
}
]Exemplo de Requisição POST com Objeto Find e opção Expand
O objeto de payload POST inclui parâmetros de busca adicionais que podem ser usados para refinar ainda mais a resposta do resultado.
query - O valor a ser encontrado.
filters - Lista de campo e valor que você deseja corresponder e incluir apenas como parte do resultado.
orderBy - Lista de campos e ordem de classificação pela qual você deseja ordenar os resultados. (ASC - Crescente, DESC - Decrescente)
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"
}
]
}
}'Exemplo de Resposta
Código de status: 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": "Criado e definido como Não Iniciado por @DavidBurt",
"topicId": 22751,
"display": "Criado e definido como Não Iniciado por <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": "Item de ação do Azure DevOps atualizado com sucesso - 8153 por @System",
"topicId": 22678,
"display": "Item de ação do Azure DevOps atualizado com sucesso - <a href=\"https://fluidbusinesssolutions.visualstudio.com/9eb08e50-6927-4e91-a10d-1c0ab6d578d6/_workitems/edit/8153\" target=\"_blank\" rel=\"noopener noreferrer\">8153</a> por <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 alterado de Em Andamento para Não Iniciado por @DavidBurt",
"topicId": 22733,
"display": "Status alterado de Em Andamento para Não Iniciado por <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 alterado de Não Iniciado para Em Andamento por @DavidBurt",
"topicId": 22732,
"display": "Status alterado de Não Iniciado para Em Andamento por <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"
}
]Definições
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Board específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid, identifica exclusivamente este Board específico, pode ser intercambiável com id, veja acima |
url | A URL REST GET para este Board |
fields | Mapa de campos e valores para o Board |
name | Nome do Board |
description | Descrição para este Board |
mailToAddress | |
modifiedBy | O usuário que modificou este Board por último |
membersOnly | |
isPrivate | Board é privado |
members[] | Descreve uma lista de usuários que são membros deste board e podem contribuir com o board |
owners[] | Descreve uma lista de usuários pelos quais este Board é de propriedade, os proprietários podem atualizar a configuração do Board |
viewers[] | Descreve uma lista de usuários que têm acesso somente de visualização ao Board, esses usuários não podem contribuir com o board. |
cardType[] | Lista de tipos de tarefa/card suportados que podem ser criados neste Board |
columns[] | Lista das colunas do Board |
subBoards[] | Se este for um workspace de Board, lista de sub boards associados a este workspace, os sub boards compartilham a mesma configuração do workspace do board, como colunas e cardTypes etc |
ModifiedBy
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid, identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Members[]
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid, identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Owners[]
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid, identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Viewers[]
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid, identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
CardType[]
Nome | Descrição |
cardType | Nome do tipo de tarefa/card que pode ser criado neste Board |
colourHexValue | Cor associada a esta tarefa/card conforme exibida no Board e no diálogo de criação de tarefa/card |
isDefault | Tarefa/card padrão selecionado ao criar, conforme exibido no diálogo de criação |
Columns[]
Nome | Descrição |
id | A string guid, identifica exclusivamente esta coluna específica |
title | O título desta coluna |
state | estado/status desta coluna; qualquer cartão nesta coluna terá este estado/status aplicado |
slaDays | |
complete | Esta coluna é uma coluna de estado/status concluído |
rating | valor de classificação inteiro a ser aplicado nesta coluna |
order | ordenação de posição da esquerda para a direita desta coluna |
SubBoards[]
Nome | Descrição |
id | O inteiro Id, identifica exclusivamente este Board específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid, identifica exclusivamente este Board específico, pode ser intercambiável com id, veja acima |
title | |
status | O nome de usuário associado a este Usuário |
modifiedBy | E-mail exclusivo associado a este Usuário |
createdBy | |
taskCount | |
targetGuid |