Sdílet prostřednictvím


Dashboards - Get

Získejte řídicí panel podle jeho ID.

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
dashboardId
path True

string

uuid
organization
path True

string

Název organizace Azure DevOps.

project
path True

string

ID projektu nebo název projektu

team
path

string

ID týmu nebo název týmu

api-version
query True

string

Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.3.

Odpovědi

Name Typ Description
200 OK

Dashboard

úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Rozsahy

Name Description
vso.dashboards Uděluje možnost číst informace o týmovém řídicím panelu.

Příklady

Ukázkový požadavek

GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025?api-version=7.1-preview.3

Ukázková odpověď

{
  "id": "759b486a-e22a-4692-bf40-e2deec0de530",
  "name": "Overview",
  "refreshInterval": 0,
  "position": 1,
  "eTag": "2",
  "widgets": [
    {
      "id": "c64731a0-8c47-4b6e-92dc-25668e004e1d",
      "eTag": "1",
      "name": "Team Members",
      "position": {
        "row": 1,
        "column": 6
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/c64731a0-8c47-4b6e-92dc-25668e004e1d",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/c64731a0-8c47-4b6e-92dc-25668e004e1d"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.TeamMembersWidget"
    },
    {
      "id": "3e55ea7a-46c6-43c5-ba0d-475093d4e483",
      "eTag": "1",
      "name": "Open User Stories",
      "position": {
        "row": 1,
        "column": 3
      },
      "size": {
        "rowSpan": 2,
        "columnSpan": 3
      },
      "settings": "{\"query\":{\"queryId\":\"3c242d67-38f1-41d8-b8af-1f7fb218940d\", \"queryName\": \"Open User Stories\"}}",
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/3e55ea7a-46c6-43c5-ba0d-475093d4e483",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/3e55ea7a-46c6-43c5-ba0d-475093d4e483"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-mywork-web.Microsoft.VisualStudioOnline.MyWork.WitViewWidget"
    },
    {
      "id": "615c113e-becc-48fa-8f86-5acf2cb6c0cd",
      "eTag": "1",
      "name": "Work Links",
      "position": {
        "row": 2,
        "column": 6
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/615c113e-becc-48fa-8f86-5acf2cb6c0cd",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/615c113e-becc-48fa-8f86-5acf2cb6c0cd"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.WorkLinksWidget"
    },
    {
      "id": "13635e90-277f-40f0-b601-7a08de067279",
      "eTag": "1",
      "name": "Open User Stories",
      "position": {
        "row": 3,
        "column": 5
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 1
      },
      "settings": "{\"queryId\":\"3c242d67-38f1-41d8-b8af-1f7fb218940d\", \"queryName\": \"Open User Stories\"}",
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "artifactId": "",
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/13635e90-277f-40f0-b601-7a08de067279",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/13635e90-277f-40f0-b601-7a08de067279"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.QueryScalarWidget"
    },
    {
      "id": "673670cc-8efc-4bf8-9dd8-7c83804bdf75",
      "eTag": "1",
      "name": "New Work Item",
      "position": {
        "row": 3,
        "column": 3
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "artifactId": "",
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/673670cc-8efc-4bf8-9dd8-7c83804bdf75",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/673670cc-8efc-4bf8-9dd8-7c83804bdf75"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.NewWorkItemWidget",
      "configurationContributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.NewWorkItemWidget.Configuration"
    },
    {
      "id": "abd84deb-2c64-4df1-9b8b-92f9a7e29f77",
      "eTag": "1",
      "name": "Markdown",
      "position": {
        "row": 1,
        "column": 8
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": "#####Markdown\nAdd content using the markdown widget.\n- **Bold**\n- *Italic*\n- [Links]()",
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/abd84deb-2c64-4df1-9b8b-92f9a7e29f77",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/abd84deb-2c64-4df1-9b8b-92f9a7e29f77"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.MarkdownWidget",
      "configurationContributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.MarkdownWidget.Configuration"
    },
    {
      "id": "07c1d6e4-ff3c-421a-a165-9fabd10ab623",
      "eTag": "1",
      "name": "Visual Studio Shortcuts",
      "position": {
        "row": 3,
        "column": 6
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "artifactId": "",
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/07c1d6e4-ff3c-421a-a165-9fabd10ab623",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/07c1d6e4-ff3c-421a-a165-9fabd10ab623"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.VSLinksWidget"
    },
    {
      "id": "af696a7f-2e1e-4068-92a6-af164de70cd5",
      "eTag": "1",
      "name": "Sprint Burndown",
      "position": {
        "row": 3,
        "column": 1
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/af696a7f-2e1e-4068-92a6-af164de70cd5",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/af696a7f-2e1e-4068-92a6-af164de70cd5"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.SprintBurndownWidget"
    },
    {
      "id": "f2329867-71ea-4a77-a676-e1a98263e4bd",
      "eTag": "1",
      "name": "Welcome",
      "position": {
        "row": 1,
        "column": 1
      },
      "size": {
        "rowSpan": 2,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/f2329867-71ea-4a77-a676-e1a98263e4bd",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/f2329867-71ea-4a77-a676-e1a98263e4bd"
        },
        "group": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
        },
        "dashboard": {
          "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
        }
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.HowToLinksWidget"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards"
    },
    "widget": [
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/c64731a0-8c47-4b6e-92dc-25668e004e1d"
      },
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/3e55ea7a-46c6-43c5-ba0d-475093d4e483"
      },
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/615c113e-becc-48fa-8f86-5acf2cb6c0cd"
      },
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/13635e90-277f-40f0-b601-7a08de067279"
      },
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/673670cc-8efc-4bf8-9dd8-7c83804bdf75"
      },
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/abd84deb-2c64-4df1-9b8b-92f9a7e29f77"
      },
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/07c1d6e4-ff3c-421a-a165-9fabd10ab623"
      },
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/af696a7f-2e1e-4068-92a6-af164de70cd5"
      },
      {
        "href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/f2329867-71ea-4a77-a676-e1a98263e4bd"
      }
    ]
  }
}

Definice

Name Description
Dashboard

Model řídicího panelu

DashboardScope

Rozsah řídicího panelu. Může to být projekt nebo Project_Team

LightboxOptions

Konfigurace Lightboxu

ReferenceLinks

Třída představující kolekci odkazů REST.

SemanticVersion

správa verzí artefaktu, jak je popsáno na: http://semver.org/ve formátu major.minor.patch.

Widget

Data widgetu

WidgetPosition
WidgetSize

Dashboard

Model řídicího panelu

Name Typ Description
_links

ReferenceLinks

Třída představující kolekci odkazů REST.

dashboardScope

DashboardScope

Entita, na kterou je řídicí panel vymezen.

description

string

Popis řídicího panelu.

eTag

string

Hodnota sledování verze definovaná serverem, která se používá k úpravě detekce kolizí.

groupId

string

ID skupiny pro řídicí panel U řídicích panelů v rámci týmu se jedná o jedinečný identifikátor týmu přidruženého k řídicímu panelu. U řídicích panelů v rámci projektu je tato vlastnost prázdná.

id

string

ID řídicího panelu. Služba je poskytována při vytváření.

lastAccessedDate

string

Datum posledního přístupu k řídicímu panelu.

modifiedBy

string

ID osoby, která řídicí panel upravila.

modifiedDate

string

Datum poslední změny řídicího panelu.

name

string

Název řídicího panelu.

ownerId

string

ID vlastníka řídicího panelu U řídicích panelů v rámci týmu se jedná o jedinečný identifikátor týmu přidruženého k řídicímu panelu. U řídicích panelů v rámci projektu se jedná o jedinečný identifikátor identity uživatele přidružené k řídicímu panelu.

position

integer

Umístění řídicího panelu ve skupině řídicího panelu Pokud se při vytváření nenasadí, o pozici rozhoduje služba.

refreshInterval

integer

Interval automatické aktualizace řídicího panelu klientem Vyjádřeno v minutách.

url

string

widgets

Widget[]

Sada widgetů na řídicím panelu.

DashboardScope

Rozsah řídicího panelu. Může to být projekt nebo Project_Team

Hodnota Description
collection_User

[ZASTARALÉ] Řídicí panel je vymezený na uživatele kolekce.

project

Řídicí panel je vymezený na projekt.

project_Team

Řídicí panel je vymezený na tým.

LightboxOptions

Konfigurace Lightboxu

Name Typ Description
height

integer

Výška požadovaného lightboxu v pixelech

resizable

boolean

True pro povolení změny velikosti lightboxu, false pro zakázání změny velikosti lightboxu, výchozí hodnota je false.

width

integer

Šířka požadovaného lightboxu v pixelech

Třída představující kolekci odkazů REST.

Name Typ Description
links

object

Zobrazení odkazů jen pro čtení. Odkazy jsou jen pro čtení, a proto je chceme zveřejnit jen jako odkazy jen pro čtení.

SemanticVersion

správa verzí artefaktu, jak je popsáno na: http://semver.org/ve formátu major.minor.patch.

Name Typ Description
major

integer

Hlavní verze při provádění nekompatibilních změn rozhraní API

minor

integer

Podverze při přidávání funkcí zpětně kompatibilním způsobem

patch

integer

Oprava verze při provádění zpětně kompatibilních oprav chyb

Widget

Data widgetu

Name Typ Description
_links

ReferenceLinks

Třída představující kolekci odkazů REST.

allowedSizes

WidgetSize[]

Odkazuje na povolené velikosti widgetu. Toto se vyplní, když chce uživatel nakonfigurovat widget.

areSettingsBlockedForUser

boolean

Read-Only vlastnost ze služby řídicího panelu. Označuje, jestli je nastavení pro aktuálního uživatele blokované.

artifactId

string

Odkazuje na jedinečný identifikátor artefaktu funkce. Používá se k připnutí a odepnutí konkrétního artefaktu.

configurationContributionId

string

configurationContributionRelativeId

string

contentUri

string

contributionId

string

ID základního příspěvku definující zadanou konfiguraci widgetu.

dashboard

Dashboard

Volitelný částečný obsah řídicího panelu pro podporu výměny značky ETag na úrovni řídicího panelu pro rozhraní API na úrovni widgetů

eTag

string

id

string

isEnabled

boolean

isNameConfigurable

boolean

lightboxOptions

LightboxOptions

Konfigurace Lightboxu

loadingImageUrl

string

name

string

position

WidgetPosition

settings

string

settingsVersion

SemanticVersion

správa verzí artefaktu, jak je popsáno na: http://semver.org/ve formátu major.minor.patch.

size

WidgetSize

typeId

string

url

string

WidgetPosition

Name Typ Description
column

integer

row

integer

WidgetSize

Name Typ Description
columnSpan

integer

Šířka widgetu vyjádřená ve sloupcích mřížky řídicího panelu

rowSpan

integer

Výška widgetu vyjádřená v řádcích mřížky řídicího panelu