List all activities

get/compute-ops-mgmt/v1beta2/activities

Retrieve the list of activities

URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The old prefix will continue to be supported to allow for a smooth transition. The Guide contains more information about this change.

SecurityBearer
Request
query Parameters
groups
integer [ 1 .. 10 ]

Specify the number of groups of activities that should be returned. A group of activities is a single activity item that corresponds to one or more activities with the same activity key that occurred back-to-back. A group of activities might be "5 servers assigned to Compute Ops Management" or "12 servers firmware update successful". This parameter has no relation to the groups resource.

offset
integer >= 0
Default: 0

Zero-based resource offset to start the response from

Example: offset=10
limit
integer [ 0 .. 1000 ]
Default: 100

The maximum number of records to return.

Example: limit=100
filter
string

Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.

NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters ! # $ & ' ( ) * + , / : ; = ? @ [ ] must be encoded with percent encoded equivalents. Server IDs contain a +, which must be encoded as %2B.
For example: the value P06760-B21+2M212504P8 must be encoded as P06760-B21%2B2M212504P8 when it is used in a query parameter.

CLASS EXAMPLES
Types integer, decimal, timestamp, string, boolean, null
Operations eq, ne, gt, ge, lt, le, in
Logic and, or, not

Activities can be filtered by:

  • associatedServerUri
  • associatedServerId
  • createdAt
  • groupId
  • groupDisplayName
  • healthState
  • hidden
  • id
  • key
  • resourceUri
  • selfUri
  • serverSettingsId
  • serverSettingsName
  • serverSettingsCategory
  • source/resourceUri
  • source/type
  • source/displayName
  • source/originId

The following examples are not an exhaustive list of all possible filtering options.

Examples:
Return activities where a property equals a value. <property> eq <value>
filter=generation eq '1'
Return activities where a nested property equals a value. <property>/<nestedProperty> eq <value>
filter=source/type eq 'compute-ops/activity'
Return activities where a property equals a value, using a url. <property>%20eq%20%27<value>
filter=associatedServerId%20eq%20%27P06760-B21%2B2M212504P8
Return activities where a property does not equal a value not <property> eq <value>
filter=not source/type eq 'compute-ops/jobs'
Return activities with populated property. not <property> eq null
filter=not source eq null
Return activities where property contains a value. contains(<property>, <value>)
filter=contains(createdAt,'2019')
Return activities where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
filter=not source/displayName eq null and contains(type,'compute-ops/activity')
Return activities where property is one of multiple values. <property>/<nestedProperty> in (<value>,<value>)
filter=createdAt in ('2019-08-24T14:15:22Z','2020-08-24T14:15:22Z')
sort
string

The order in which to return the resources in the collection.

The value of the sort query parameter is a comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direciton indicator is omitted the default direction is ascending.

Examples:
Order resources ascending by name
sort=name asc
Order resources ascending by name and then by descending by createdAt
sort=name,createdAt desc
header Parameters
Accept-Language
string

Current supported languages are en (English) and ja (Japanese)

A blank header or one containing only non-supported languages will return activities in English. Otherwise, activities will be returned in the highest weighted supported language.

NOTE: This header should follow the format shown here using IETF language tags

Examples:
en
ja
de,en
fr,ja;q=0.9,en;q=0.7
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Responses
200

OK

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "count": 1,
  • "total": 12,
  • "items": [
    ]
}