The Asset Activity 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.

asset string required
subject string required
date string

Default: now

user string required
The Asset Activity object 
{
  "id": "asset-activity_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "asset": "asset_example",
  "subject": "subject_example",
  "date": "now",
  "user": "user_example"
}
GET /api/assets/asset-activity/{id}

Retrieve a asset activity

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

Path parameters

id string required

The identifier of the asset activity to retrieve.

Returns

Returns the asset activity object if a valid identifier was provided.

GET /api/assets/asset-activity/{id} 
curl https://api.overplane.dev/api/assets/asset-activity/asset-activity_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "asset-activity_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "asset": "asset_example",
  "subject": "subject_example",
  "date": "now",
  "user": "user_example"
}
GET /api/assets/asset-activity

List all asset activitys

Returns a list of asset activitys. 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 activity objects.

GET /api/assets/asset-activity 
curl https://api.overplane.dev/api/assets/asset-activity \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "asset-activity_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "asset": "asset_example",
      "subject": "subject_example",
      "date": "now",
      "user": "user_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/asset-activity

Create a asset activity

Creates a new asset activity object.

Body parameters

asset string required
subject string required
date string

Default: now

user string required

Returns

Returns the newly created asset activity object if the call succeeded.

POST /api/assets/asset-activity 
curl https://api.overplane.dev/api/assets/asset-activity \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"asset":"asset_example","subject":"subject_example","user":"user_example"}'
Response 
{
  "id": "asset-activity_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "asset": "asset_example",
  "subject": "subject_example",
  "date": "now",
  "user": "user_example"
}
PATCH /api/assets/asset-activity/{id}

Update a asset activity

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

Body parameters

asset string
subject string
date string

Default: now

user string

Returns

Returns the updated asset activity object.

PATCH /api/assets/asset-activity/{id} 
curl https://api.overplane.dev/api/assets/asset-activity/asset-activity_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"asset":"asset_example","subject":"subject_example"}'
Response 
{
  "id": "asset-activity_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "asset": "asset_example",
  "subject": "subject_example",
  "date": "now",
  "user": "user_example"
}
DELETE /api/assets/asset-activity/{id}

Delete a asset activity

Permanently deletes a asset activity. This cannot be undone.

Path parameters

id string required

The identifier of the asset activity to delete.

Returns

Returns a confirmation that the asset activity has been deleted.

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