The Supplier Scorecard Scoring Criteria object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
criteria_name string required
score number
weight number required
max_score number

Default: 100

formula string
The Supplier Scorecard Scoring Criteria object 
{
  "id": "supplier-scorecard-scoring-criteria_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "criteria_name": "criteria_name_example",
  "score": 0,
  "weight": 0,
  "max_score": 100,
  "formula": "formula_example"
}
GET /api/buying/supplier-scorecard-scoring-criteria?parent_id={id}

List supplier scorecard scoring criterias by parent

Returns all supplier scorecard scoring criterias belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of supplier scorecard scoring criteria objects belonging to the parent.

GET /api/buying/supplier-scorecard-scoring-criteria?parent_id={id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-scoring-criteria?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "supplier-scorecard-scoring-criteria_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "criteria_name": "criteria_name_example",
      "score": 0,
      "weight": 0,
      "max_score": 100,
      "formula": "formula_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/supplier-scorecard-scoring-criteria

Create a supplier scorecard scoring criteria

Creates a new supplier scorecard scoring criteria object.

Body parameters

idx integer
parent_id string required
parent_type string required
criteria_name string required
score number
weight number required
max_score number

Default: 100

formula string

Returns

Returns the newly created supplier scorecard scoring criteria object if the call succeeded.

POST /api/buying/supplier-scorecard-scoring-criteria 
curl https://api.overplane.dev/api/buying/supplier-scorecard-scoring-criteria \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example","criteria_name":"criteria_name_example","weight":0}'
Response 
{
  "id": "supplier-scorecard-scoring-criteria_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "criteria_name": "criteria_name_example",
  "score": 0,
  "weight": 0,
  "max_score": 100,
  "formula": "formula_example"
}
PATCH /api/buying/supplier-scorecard-scoring-criteria/{id}

Update a supplier scorecard scoring criteria

Updates the specified supplier scorecard scoring criteria by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the supplier scorecard scoring criteria to update.

Body parameters

idx integer
parent_id string
parent_type string
criteria_name string
score number
weight number
max_score number

Default: 100

formula string

Returns

Returns the updated supplier scorecard scoring criteria object.

PATCH /api/buying/supplier-scorecard-scoring-criteria/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-scoring-criteria/supplier-scorecard-scoring-criteria_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "supplier-scorecard-scoring-criteria_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "criteria_name": "criteria_name_example",
  "score": 0,
  "weight": 0,
  "max_score": 100,
  "formula": "formula_example"
}
DELETE /api/buying/supplier-scorecard-scoring-criteria/{id}

Delete a supplier scorecard scoring criteria

Permanently deletes a supplier scorecard scoring criteria. This cannot be undone.

Path parameters

id string required

The identifier of the supplier scorecard scoring criteria to delete.

Returns

Returns a confirmation that the supplier scorecard scoring criteria has been deleted.

DELETE /api/buying/supplier-scorecard-scoring-criteria/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-scoring-criteria/supplier-scorecard-scoring-criteria_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "supplier-scorecard-scoring-criteria_abc123",
  "deleted": true
}
POST /api/buying/supplier-scorecard-scoring-criteria/reorder

Reorder supplier scorecard scoring criterias

Updates the sort order of supplier scorecard scoring criterias within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/buying/supplier-scorecard-scoring-criteria/reorder 
curl https://api.overplane.dev/api/buying/supplier-scorecard-scoring-criteria/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "supplier-scorecard-scoring-criteria_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "criteria_name": "criteria_name_example",
  "score": 0,
  "weight": 0,
  "max_score": 100,
  "formula": "formula_example"
}