DigiLEAN Connect
Search K

Appearance

GET /v2/boards​

GET
/v2/boards

Parameters

Query Parameters

$searchstring

Specifies OData search phrases. Numeric values must be enclosed in quotes (e.g., "1234"). This parameter is mutually exclusive with $filter. Each word is treated as a search key; a match with any key is considered successful. To search for keywords containing spaces, enclose the entire phrase in quotes (e.g., "this is example").

$filterstring

OData filter expression

$selectstring

OData select expression

$topinteger

OData top (limit) expression

$skipinteger

OData skip (offset) expression

$expandstring

OData expand expression to include related entities (navigation properties) in the response.

$countboolean

OData count expression to include a count of the total number of items in the response.

$orderbystring

OData order by expression

Responses​

OK

JSON
{
"@odata.count": 0,
"@odata.nextLink": "string",
"value": [
{
"id": 0,
"name": "string",
"boardType": "string",
"businessUnitId": 0,
"isMember": true,
"projectId": 0,
"isPublic": true,
"groupId": 0,
"group": {
"id": 0,
"type": "string",
"name": "string",
"description": "string",
"parentId": 0,
"parent": "[Circular Reference]",
"isSystemGroup": true,
"level": 0,
"sortOrder": 0,
"businessUnitId": 0,
"projectId": 0,
"externalId": "string",
"externalName": "string",
"users": [
{
"groupId": 0,
"userId": "string",
"role": "string",
"group": "[Circular Reference]",
"user": {
"id": "string",
"userName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"displayName": "string",
"type": "string",
"businessUnitId": 0,
"groups": [
{
}
]
}
}
],
"boards": [
{
}
]
},
"tasks": [
{
"id": 0,
"parentId": 0,
"lastModified": "string",
"responsibleUser": "string",
"responsibleUserId": "string",
"externalId": "string",
"boardId": 0,
"board": "[Circular Reference]",
"title": "string",
"description": "string",
"status": "string",
"dueDate": "string",
"startDate": "string",
"rowCategoryId": 0,
"columnCategoryId": 0,
"lastModifiedByUserId": "string",
"lastModifiedByUser": "string",
"tags": [
"string"
],
"comments": [
{
"id": 0,
"parentId": 0,
"level": 0,
"comment": "string",
"commentedBy": "string",
"commentedByUserId": "string",
"commentDate": "string",
"taskId": 0,
"task": "[Circular Reference]",
"commentedByUserDisplayName": "string"
}
],
"attachments": [
{
"id": "string",
"fileName": "string",
"fileUrl": "string",
"contentType": "string",
"name": "string",
"previewFileName": "string",
"hasPreview": true,
"fileExtension": "string",
"eTag": "string",
"fileSizeInBytes": 0,
"fileSizeInKb": 0,
"createdDate": "string",
"createdByUserId": "string",
"createdByUser": "string",
"lastModified": "string",
"lastModifiedByUserId": "string",
"lastModifiedByUser": "string",
"mimeType": "string",
"isImage": true
}
]
}
]
}
]
}