The Supplier Scorecard Variable object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

variable_label string required
is_custom boolean

Default: false

param_name string required
path string required
description string
The Supplier Scorecard Variable object 
{
  "id": "supplier-scorecard-variable_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "variable_label": "variable_label_example",
  "is_custom": false,
  "param_name": "param_name_example",
  "path": "path_example",
  "description": "description_example"
}
GET /api/buying/supplier-scorecard-variable/{id}

Retrieve a supplier scorecard variable

Retrieves the details of an existing supplier scorecard variable. Supply the unique supplier scorecard variable ID that was returned from a previous request.

Path parameters

id string required

The identifier of the supplier scorecard variable to retrieve.

Returns

Returns the supplier scorecard variable object if a valid identifier was provided.

GET /api/buying/supplier-scorecard-variable/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-variable/supplier-scorecard-variable_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "supplier-scorecard-variable_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "variable_label": "variable_label_example",
  "is_custom": false,
  "param_name": "param_name_example",
  "path": "path_example",
  "description": "description_example"
}
GET /api/buying/supplier-scorecard-variable

List all supplier scorecard variables

Returns a list of supplier scorecard variables. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of supplier scorecard variable objects.

GET /api/buying/supplier-scorecard-variable 
curl https://api.overplane.dev/api/buying/supplier-scorecard-variable \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "supplier-scorecard-variable_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "variable_label": "variable_label_example",
      "is_custom": false,
      "param_name": "param_name_example",
      "path": "path_example",
      "description": "description_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/buying/supplier-scorecard-variable

Create a supplier scorecard variable

Creates a new supplier scorecard variable object.

Body parameters

variable_label string required
is_custom boolean

Default: false

param_name string required
path string required
description string

Returns

Returns the newly created supplier scorecard variable object if the call succeeded.

POST /api/buying/supplier-scorecard-variable 
curl https://api.overplane.dev/api/buying/supplier-scorecard-variable \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"variable_label":"variable_label_example","param_name":"param_name_example","path":"path_example"}'
Response 
{
  "id": "supplier-scorecard-variable_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "variable_label": "variable_label_example",
  "is_custom": false,
  "param_name": "param_name_example",
  "path": "path_example",
  "description": "description_example"
}
PATCH /api/buying/supplier-scorecard-variable/{id}

Update a supplier scorecard variable

Updates the specified supplier scorecard variable 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 variable to update.

Body parameters

variable_label string
is_custom boolean

Default: false

param_name string
path string
description string

Returns

Returns the updated supplier scorecard variable object.

PATCH /api/buying/supplier-scorecard-variable/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-variable/supplier-scorecard-variable_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"variable_label":"variable_label_example","is_custom":false}'
Response 
{
  "id": "supplier-scorecard-variable_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "variable_label": "variable_label_example",
  "is_custom": false,
  "param_name": "param_name_example",
  "path": "path_example",
  "description": "description_example"
}
DELETE /api/buying/supplier-scorecard-variable/{id}

Delete a supplier scorecard variable

Permanently deletes a supplier scorecard variable. This cannot be undone.

Path parameters

id string required

The identifier of the supplier scorecard variable to delete.

Returns

Returns a confirmation that the supplier scorecard variable has been deleted.

DELETE /api/buying/supplier-scorecard-variable/{id} 
curl https://api.overplane.dev/api/buying/supplier-scorecard-variable/supplier-scorecard-variable_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "supplier-scorecard-variable_abc123",
  "deleted": true
}