Scorecards

Get Scorecard Results

GET/api/v1/scorecards/results

Query parameters

Response

Successful Response

Body

items*Items

totalTotal

Total items

current_pageCurrent Page

Cursor to refetch the current page

current_page_backwardsCurrent Page Backwards

Cursor to refetch the current page starting from the last item

previous_pagePrevious Page

Cursor for the previous page

next_pageNext Page

Cursor for the next page

Request

const response = await fetch('/api/v1/scorecards/results', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "scorecardId": "text",
      "entityId": "text",
      "currentRank": "text",
      "updatedAt": "2024-10-18T04:09:05.736Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Get Scorecard Results By Scorecard

GET/api/v1/scorecards/{id_}/results

Path parameters

id_*Id

Pattern: ^([a-z0-9_.-]+)$

Query parameters

Response

Successful Response

Body

items*Items

totalTotal

Total items

current_pageCurrent Page

Cursor to refetch the current page

current_page_backwardsCurrent Page Backwards

Cursor to refetch the current page starting from the last item

previous_pagePrevious Page

Cursor for the previous page

next_pageNext Page

Cursor for the next page

Request

const response = await fetch('/api/v1/scorecards/{id_}/results', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "scorecardId": "text",
      "entityId": "text",
      "currentRank": "text",
      "updatedAt": "2024-10-18T04:09:05.736Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Get Scorecards

GET/api/v1/scorecards

Query parameters

Response

Successful Response

Body

items*Items

totalTotal

Total items

current_pageCurrent Page

Cursor to refetch the current page

current_page_backwardsCurrent Page Backwards

Cursor to refetch the current page starting from the last item

previous_pagePrevious Page

Cursor for the previous page

next_pageNext Page

Cursor for the next page

Request

const response = await fetch('/api/v1/scorecards', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "isActive": true,
      "blueprintId": "text",
      "ranks": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "rules": [
            {
              "id": "text",
              "title": "text",
              "description": "text",
              "icon": "text",
              "conditions": [
                {
                  "field": "text",
                  "expression": false,
                  "operator": "eq"
                }
              ]
            }
          ]
        }
      ],
      "medianRank": "text",
      "createdAt": "2024-10-18T04:09:05.736Z",
      "updatedAt": "2024-10-18T04:09:05.736Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Scorecard

POST/api/v1/scorecards

Body

idId

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

ranksRanks

medianRankMedianrank

Response

Successful Response

Body

idId

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

ranksRanks

medianRankMedianrank

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

const response = await fetch('/api/v1/scorecards', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "blueprintId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "blueprintId": "text",
  "ranks": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "rules": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "conditions": [
            {
              "field": "text",
              "expression": false,
              "operator": "eq"
            }
          ]
        }
      ]
    }
  ],
  "medianRank": "text",
  "createdAt": "2024-10-18T04:09:05.736Z",
  "updatedAt": "2024-10-18T04:09:05.736Z"
}

Get Scorecard

GET/api/v1/scorecards/{id_}

Path parameters

id_*Id

Response

Successful Response

Body

idId

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

ranksRanks

medianRankMedianrank

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

const response = await fetch('/api/v1/scorecards/{id_}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "blueprintId": "text",
  "ranks": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "rules": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "conditions": [
            {
              "field": "text",
              "expression": false,
              "operator": "eq"
            }
          ]
        }
      ]
    }
  ],
  "medianRank": "text",
  "createdAt": "2024-10-18T04:09:05.736Z",
  "updatedAt": "2024-10-18T04:09:05.736Z"
}

Upsert Scorecard

PUT/api/v1/scorecards/{id_}

Path parameters

id_*Id

Pattern: ^([a-z0-9_.-]+)$

Body

idId

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

ranksRanks

medianRankMedianrank

Response

Successful Response

Body

idId

Pattern: ^([a-z0-9_.-]+)$

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

Pattern: ^([a-z0-9_.-]+)$

ranksRanks

medianRankMedianrank

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

const response = await fetch('/api/v1/scorecards/{id_}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "blueprintId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "blueprintId": "text",
  "ranks": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "rules": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "icon": "text",
          "conditions": [
            {
              "field": "text",
              "expression": false,
              "operator": "eq"
            }
          ]
        }
      ]
    }
  ],
  "medianRank": "text",
  "createdAt": "2024-10-18T04:09:05.736Z",
  "updatedAt": "2024-10-18T04:09:05.736Z"
}

Delete Scorecard

DELETE/api/v1/scorecards/{id_}

Path parameters

id_*Id

Pattern: ^([a-z0-9_.-]+)$

Response

Successful Response

Request

const response = await fetch('/api/v1/scorecards/{id_}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Evaluate Scorecard

POST/api/v1/scorecards/{id_}/evaluate

Path parameters

id_*Id

Pattern: ^([a-z0-9_.-]+)$

Response

Successful Response

Request

const response = await fetch('/api/v1/scorecards/{id_}/evaluate', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Troubleshooting

PreviousEntities NextSelf-Service Action Runs

Last updated 4 months ago