The Asset Shift Factor 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.

shift_name string required
shift_factor number required
default boolean

Default: false

The Asset Shift Factor object 
{
  "id": "asset-shift-factor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "shift_name": "shift_name_example",
  "shift_factor": 0,
  "default": false
}
GET /api/assets/asset-shift-factor/{id}

Retrieve a asset shift factor

Retrieves the details of an existing asset shift factor. Supply the unique asset shift factor ID that was returned from a previous request.

Path parameters

id string required

The identifier of the asset shift factor to retrieve.

Returns

Returns the asset shift factor object if a valid identifier was provided.

GET /api/assets/asset-shift-factor/{id} 
curl https://api.overplane.dev/api/assets/asset-shift-factor/asset-shift-factor_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-shift-factor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "shift_name": "shift_name_example",
  "shift_factor": 0,
  "default": false
}
GET /api/assets/asset-shift-factor

List all asset shift factors

Returns a list of asset shift factors. 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 asset shift factor objects.

GET /api/assets/asset-shift-factor 
curl https://api.overplane.dev/api/assets/asset-shift-factor \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-shift-factor_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "shift_name": "shift_name_example",
      "shift_factor": 0,
      "default": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-shift-factor

Create a asset shift factor

Creates a new asset shift factor object.

Body parameters

shift_name string required
shift_factor number required
default boolean

Default: false

Returns

Returns the newly created asset shift factor object if the call succeeded.

POST /api/assets/asset-shift-factor 
curl https://api.overplane.dev/api/assets/asset-shift-factor \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"shift_name":"shift_name_example","shift_factor":0}'
Response 
{
  "id": "asset-shift-factor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "shift_name": "shift_name_example",
  "shift_factor": 0,
  "default": false
}
PATCH /api/assets/asset-shift-factor/{id}

Update a asset shift factor

Updates the specified asset shift factor 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 asset shift factor to update.

Body parameters

shift_name string
shift_factor number
default boolean

Default: false

Returns

Returns the updated asset shift factor object.

PATCH /api/assets/asset-shift-factor/{id} 
curl https://api.overplane.dev/api/assets/asset-shift-factor/asset-shift-factor_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"shift_name":"shift_name_example","shift_factor":0}'
Response 
{
  "id": "asset-shift-factor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "shift_name": "shift_name_example",
  "shift_factor": 0,
  "default": false
}
DELETE /api/assets/asset-shift-factor/{id}

Delete a asset shift factor

Permanently deletes a asset shift factor. This cannot be undone.

Path parameters

id string required

The identifier of the asset shift factor to delete.

Returns

Returns a confirmation that the asset shift factor has been deleted.

DELETE /api/assets/asset-shift-factor/{id} 
curl https://api.overplane.dev/api/assets/asset-shift-factor/asset-shift-factor_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "asset-shift-factor_abc123",
  "deleted": true
}