Overview

Authentication

Users can create access keys for the API via the Settings page.

These keys serve as credentials for authenticating access to Rely's REST API. To authenticate, include the key in the 'Authorization' header of the API request, formatted as "Bearer {your_token_here}".

Token Expiration and Limitations

Tokens created via this process are valid for a duration of 10 years.

However, users are limited to one active token at any given time. Generating a new token will automatically deactivate any previously issued token.

If you feel the need to have more than one token valid at each time, feel free to reach out to [e-mail].

Endpoints

Get Blueprints

GET/api/v1/blueprints

Query parameters

Response

200422

Successful Response

Body

application/json

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

JavaScriptCurl

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

Response

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "icon": "text",
      "schemaProperties": {
        "type": "object",
        "title": "text",
        "description": "text",
        "format": "text",
        "items": {
          "type": [
            "text"
          ],
          "title": "text",
          "description": "text",
          "format": "text",
          "icon": "text",
          "enum": [],
          "additionalProperties": false,
          "readOnly": false
        },
        "icon": "text",
        "enum": [],
        "additionalProperties": false,
        "readOnly": false
      },
      "options": {
        "showInSideBar": true
      },
      "isActive": true,
      "isHideable": true,
      "createdAt": "2024-04-27T02:55:03.641Z",
      "updatedAt": "2024-04-27T02:55:03.641Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Blueprint

POST/api/v1/blueprints

Query parameters

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

Response

201422

Successful Response

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "type": "object",
    "title": "text",
    "description": "text",
    "format": "text",
    "items": {
      "type": [
        "text"
      ],
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "icon": "text",
    "enum": [],
    "additionalProperties": false,
    "readOnly": false
  },
  "options": {
    "showInSideBar": true
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Create Or Update Blueprint

PUT/api/v1/blueprints

Query parameters

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

Response

201422

Successful Response

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "type": "object",
    "title": "text",
    "description": "text",
    "format": "text",
    "items": {
      "type": [
        "text"
      ],
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "icon": "text",
    "enum": [],
    "additionalProperties": false,
    "readOnly": false
  },
  "options": {
    "showInSideBar": true
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Create Or Update Blueprints Bulk

PUT/api/v1/blueprints/bulk

Query parameters

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

Response

201422

Successful Response

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

Request

JavaScriptCurl

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

Response

[
  {
    "id": "text",
    "title": "text",
    "description": "text",
    "icon": "text",
    "schemaProperties": {
      "type": "object",
      "title": "text",
      "description": "text",
      "format": "text",
      "items": {
        "type": [
          "text"
        ],
        "title": "text",
        "description": "text",
        "format": "text",
        "icon": "text",
        "enum": [],
        "additionalProperties": false,
        "readOnly": false
      },
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "options": {
      "showInSideBar": true
    },
    "isActive": true,
    "isHideable": true,
    "createdAt": "2024-04-27T02:55:03.641Z",
    "updatedAt": "2024-04-27T02:55:03.641Z"
  }
]

Get Blueprint

GET/api/v1/blueprints/{id_}

Path parameters

id_*Id

Query parameters

Response

200422

Successful Response

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "type": "object",
    "title": "text",
    "description": "text",
    "format": "text",
    "items": {
      "type": [
        "text"
      ],
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "icon": "text",
    "enum": [],
    "additionalProperties": false,
    "readOnly": false
  },
  "options": {
    "showInSideBar": true
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Update Blueprint

PUT/api/v1/blueprints/{id_}

Path parameters

id_*Id

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

Response

200422

Successful Response

Body

application/json

id*Id

title*Title

descriptionDescription

iconIcon

schemaPropertiesSchemaProperties

Base class for models that exclude unset fields.

Note: This overrides any exclude_unset kwarg passed for the model and its nested models.

referencePropertiesReferenceproperties

relationsRelations

optionsBlueprintOptions

isActiveIsactive

isHideableIshideable

createdAtCreatedat

createdByCreatedby

updatedAtUpdatedat

updatedByUpdatedby

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "icon": "text",
  "schemaProperties": {
    "type": "object",
    "title": "text",
    "description": "text",
    "format": "text",
    "items": {
      "type": [
        "text"
      ],
      "title": "text",
      "description": "text",
      "format": "text",
      "icon": "text",
      "enum": [],
      "additionalProperties": false,
      "readOnly": false
    },
    "icon": "text",
    "enum": [],
    "additionalProperties": false,
    "readOnly": false
  },
  "options": {
    "showInSideBar": true
  },
  "isActive": true,
  "isHideable": true,
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Delete Blueprint

DELETE/api/v1/blueprints/{id_}

Path parameters

id_*Id

Response

204422

Successful Response

Request

JavaScriptCurl

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

Get Entities

GET/api/v1/entities

Query parameters

Response

200422

Successful Response

Body

application/json

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

JavaScriptCurl

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

Response

{
  "items": [
    {
      "id": "text",
      "blueprintId": "text",
      "title": "text",
      "description": "text",
      "isActive": true,
      "isHidden": false,
      "createdAt": "2024-04-27T02:55:03.641Z",
      "updatedAt": "2024-04-27T02:55:03.641Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Entity

POST/api/v1/entities

Body

application/json

id*Id

blueprintId*Blueprintid

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

Response

200422

Successful Response

Body

application/json

id*Id

blueprintId*Blueprintid

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

referencePropertiesReferenceproperties

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Get Entity

GET/api/v1/entities/{id_}

Path parameters

id_*Id

Query parameters

Response

200422

Successful Response

Body

application/json

id*Id

blueprintId*Blueprintid

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

referencePropertiesReferenceproperties

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Upsert Entity

PUT/api/v1/entities/{id_}

Path parameters

id_*Id

Query parameters

Body

application/json

id*Id

blueprintId*Blueprintid

titleTitle

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

Response

200422

Successful Response

Body

application/json

id*Id

blueprintId*Blueprintid

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

referencePropertiesReferenceproperties

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "blueprintId": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "isHidden": false,
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Delete Entity

DELETE/api/v1/entities/{id_}

Path parameters

id_*Id

Response

204422

Successful Response

Request

JavaScriptCurl

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

Create Or Update Entities Bulk

PUT/api/v1/entities/bulk

Query parameters

Body

application/json

id*Id

blueprintId*Blueprintid

titleTitle

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

Response

201422

Successful Response

Body

application/json

id*Id

blueprintId*Blueprintid

title*Title

descriptionDescription

isActiveIsactive

isHiddenIshidden

propertiesProperties

relationsRelations

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

referencePropertiesReferenceproperties

Request

JavaScriptCurl

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

Response

[
  {
    "id": "text",
    "blueprintId": "text",
    "title": "text",
    "description": "text",
    "isActive": true,
    "isHidden": false,
    "createdAt": "2024-04-27T02:55:03.641Z",
    "updatedAt": "2024-04-27T02:55:03.641Z"
  }
]

Get Flows

GET/api/v1/flows

Query parameters

Response

200422

Successful Response

Body

application/json

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

JavaScriptCurl

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

Response

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "isActive": true,
      "type": "automation",
      "triggers": [
        {
          "type": "onEvent",
          "conditions": [
            {
              "field": "text",
              "operator": "eq"
            }
          ],
          "event": {
            "resource": "entity",
            "action": [
              "create"
            ]
          }
        }
      ],
      "actions": [
        {
          "type": "upsertResource",
          "id": "text",
          "title": "text",
          "description": "text",
          "conditions": [
            {
              "field": "text",
              "operator": "eq"
            }
          ]
        }
      ],
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "createdAt": "2024-04-27T02:55:03.641Z",
      "updatedAt": "2024-04-27T02:55:03.641Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Flow

POST/api/v1/flows

Query parameters

Body

application/json

id*Id

title*Title

descriptionDescription

isActiveIsactive

orderOrder

type*FlowType

An enumeration.

automationselfServiceActionscorecard

argumentsArguments

secretsSecrets

triggersTriggers

actionsActions

tagsTags

Response

201422

Successful Response

Body

application/json

id*Id

title*Title

descriptionDescription

isActiveIsactive

orderOrder

type*FlowType

An enumeration.

automationselfServiceActionscorecard

argumentsArguments

secretsSecrets

triggersTriggers

actionsActions

tagsTags

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "type": "automation",
  "triggers": [
    {
      "type": "onEvent",
      "conditions": [
        {
          "field": "text",
          "operator": "eq"
        }
      ],
      "event": {
        "resource": "entity",
        "action": [
          "create"
        ]
      }
    }
  ],
  "actions": [
    {
      "type": "upsertResource",
      "id": "text",
      "title": "text",
      "description": "text",
      "conditions": [
        {
          "field": "text",
          "operator": "eq"
        }
      ]
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Get Flow

GET/api/v1/flows/{id_}

Path parameters

id_*Id

Response

200422

Successful Response

Body

application/json

id*Id

title*Title

descriptionDescription

isActiveIsactive

orderOrder

type*FlowType

An enumeration.

automationselfServiceActionscorecard

argumentsArguments

secretsSecrets

triggersTriggers

actionsActions

tagsTags

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "type": "automation",
  "triggers": [
    {
      "type": "onEvent",
      "conditions": [
        {
          "field": "text",
          "operator": "eq"
        }
      ],
      "event": {
        "resource": "entity",
        "action": [
          "create"
        ]
      }
    }
  ],
  "actions": [
    {
      "type": "upsertResource",
      "id": "text",
      "title": "text",
      "description": "text",
      "conditions": [
        {
          "field": "text",
          "operator": "eq"
        }
      ]
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Upsert Flow

PUT/api/v1/flows/{id_}

Path parameters

id_*Id

Query parameters

Body

application/json

id*Id

title*Title

descriptionDescription

isActiveIsactive

orderOrder

type*FlowType

An enumeration.

automationselfServiceActionscorecard

argumentsArguments

secretsSecrets

triggersTriggers

actionsActions

tagsTags

Response

200422

Successful Response

Body

application/json

id*Id

title*Title

descriptionDescription

isActiveIsactive

orderOrder

type*FlowType

An enumeration.

automationselfServiceActionscorecard

argumentsArguments

secretsSecrets

triggersTriggers

actionsActions

tagsTags

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "isActive": true,
  "type": "automation",
  "triggers": [
    {
      "type": "onEvent",
      "conditions": [
        {
          "field": "text",
          "operator": "eq"
        }
      ],
      "event": {
        "resource": "entity",
        "action": [
          "create"
        ]
      }
    }
  ],
  "actions": [
    {
      "type": "upsertResource",
      "id": "text",
      "title": "text",
      "description": "text",
      "conditions": [
        {
          "field": "text",
          "operator": "eq"
        }
      ]
    }
  ],
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Delete Flow

DELETE/api/v1/flows/{id_}

Path parameters

id_*Id

Response

204422

Successful Response

Request

JavaScriptCurl

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

Trigger Flow

POST/api/v1/flows/trigger/{id_}

Path parameters

id_*Id

Body

application/json

inputInput

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurl

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

Create Or Update View Config

PUT/api/v1/organizations/self/view-configs

Body

application/json

path*Path

config*Config

Response

201422

Successful Response

Body

application/json

config*Config

Request

JavaScriptCurl

const response = await fetch('/api/v1/organizations/self/view-configs', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "path": "text"
    }),
});
const data = await response.json();

Response

{}

Get Scorecard Results

GET/api/v1/scorecards/results

Query parameters

Response

200422

Successful Response

Body

application/json

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

JavaScriptCurl

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-04-27T02:55:03.641Z"
    }
  ],
  "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

Query parameters

Response

200422

Successful Response

Body

application/json

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

JavaScriptCurl

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-04-27T02:55:03.641Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Get Scorecards

GET/api/v1/scorecards

Query parameters

Response

200422

Successful Response

Body

application/json

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

JavaScriptCurl

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",
                  "operator": "eq"
                }
              ]
            }
          ]
        }
      ],
      "createdAt": "2024-04-27T02:55:03.641Z",
      "updatedAt": "2024-04-27T02:55:03.641Z"
    }
  ],
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Scorecard

POST/api/v1/scorecards

Body

application/json

idId

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

ranksRanks

Response

201422

Successful Response

Body

application/json

idId

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

ranksRanks

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurl

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",
              "operator": "eq"
            }
          ]
        }
      ]
    }
  ],
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Get Scorecard

GET/api/v1/scorecards/{id_}

Path parameters

id_*Id

Response

200422

Successful Response

Body

application/json

idId

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

ranksRanks

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurl

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",
              "operator": "eq"
            }
          ]
        }
      ]
    }
  ],
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Upsert Scorecard

PUT/api/v1/scorecards/{id_}

Path parameters

id_*Id

Body

application/json

idId

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

ranksRanks

Response

200422

Successful Response

Body

application/json

idId

title*Title

descriptionDescription

isActiveIsactive

blueprintId*Blueprintid

ranksRanks

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

Request

JavaScriptCurl

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",
              "operator": "eq"
            }
          ]
        }
      ]
    }
  ],
  "createdAt": "2024-04-27T02:55:03.641Z",
  "updatedAt": "2024-04-27T02:55:03.641Z"
}

Delete Scorecard

DELETE/api/v1/scorecards/{id_}

Path parameters

id_*Id

Response

204422

Successful Response

Request

JavaScriptCurl

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

Evaluate Scorecard

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

Path parameters

id_*Id

Response

204422

Successful Response

Request

JavaScriptCurl

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

Get View Config

GET/api/v1/legacy/users/me/view-configs

Query parameters

Response

200422

Successful Response

Body

application/json

config*Config

Request

JavaScriptCurl

const response = await fetch('/api/v1/legacy/users/me/view-configs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

Create Or Update View Config

PUT/api/v1/legacy/users/me/view-configs

Body

application/json

path*Path

config*Config

Response

201422

Successful Response

Body

application/json

config*Config

Request

JavaScriptCurl

const response = await fetch('/api/v1/legacy/users/me/view-configs', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "path": "text"
    }),
});
const data = await response.json();

Response

{}