<<

NAME

ServiceSuspension - Manage planned one-time service suspensions.

FORMAL SPECIFICATION

WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/ServiceSuspension.wsdl

JSON: https://api.cloudmonit.pl/2.0.0/json/ServiceSuspension.json

METHODS

Create

This method creates a new ServiceSuspension object.

Arguments

• comment (string)

  A short description of the suspension. This comment will be rewritten to the service's events journal when the suspension starts.

• end_timestamp (number)

  The Unix timestamp of the end of the suspension.

• service_id (unsigned integer)

  The suspended service ID.

• start_timestamp (number)

  The Unix timestamp of the beginning of the suspension.

Returns

• id (unsigned integer)

  The suspension's identifier.

Delete

This method deletes a ServiceSuspension object. Use with caution.

Arguments

• id (unsigned integer)

  The suspension's identifier.

Returns

Nothing.

Find

This method allows you to fetch information about selected ServiceSuspension objects.

Arguments

• filters - optional

  Filters to apply to the results.

  An array of objects, each containg the fields:

  • argument (string)

    The filter argument (the text to be contained in the field, or value to be compared). The argument must be of the same type as the field you filter by.

  • field (string)

    The field to filter the results by.

    Allowed values are: comment, end_timestamp, id, service_id, start_timestamp.

  • type (string)

    The type of filter. Filters (not_)greater_than and (not_)lower_than compare numbers numerically and string lexicographically. Defaults to "equals".

    Allowed values are: contains, equals, greater_than, lower_than, not_greater_than, not_lower_than.

  Maximum array length: 10.

• limit (unsigned integer or NULL) - optional

  Items per page. If not specified, NULL or 0, all elements will be fetched. You should probably specify results ordering as well, if you want the results to be consistent.

• offset (unsigned integer) - optional

  The index of the first element to show on page. Items are numbered starting from 0. Default is 0. Only meaningful if limit is specified as well.

• order - optional

  Fields to order the results by, starting from the most significant.

  An array of objects, each containg the fields:

  • direction (string) - optional

    The ordering direction, "ascending" or "descending".

    Allowed values are: ascending, descending.

    Defaults to "ascending" if not specified.

  • field (string)

    The field to order by. If not specified, the results can be returned in any order.

    Allowed values are: comment, end_timestamp, id, service_id, start_timestamp.

  Maximum array length: 10.

• with - optional

  The groups of fields to be returned with each object.

  An array of strings.

  No values are supported at the moment.

  This array cannot contain duplicate values.

  Defaults to [] if not specified.

Returns

• elements

  An array of objects, each containg the fields:

  • comment (string)

    A short description of the suspension. This comment will be rewritten to the service's events journal when the suspension starts.

  • end_timestamp (number)

    The Unix timestamp of the end of the suspension.

  • id (unsigned integer)

    The suspension's identifier.

  • service_id (unsigned integer)

    The suspended service ID.

  • start_timestamp (number)

    The Unix timestamp of the beginning of the suspension.

• total (unsigned integer)

  The total number of results (not including pagination).

Authorization

This method can be called by read-only users.

Meta

Returns the JSON or WSDL specification of the ServiceSuspension API module.

WARNING

This method is meant for internal usage in API clients. Unless you are writing one, you probably do not need it.

Arguments

• format (string) - optional

  The specification format you want to use. If omitted, defaults to json if you call this method using JSON request ot wsdl if you call this method with SOAP.

  Allowed values are: json, wsdl.

Returns

• encoded_meta (string)

  The specification of the module.

• format (string)

  The specification format used.

  Allowed values are: json, wsdl.

Authorization

This method can be called by read-only users.

Read

This method allows you to get information about a single ServiceSuspension object.

Arguments

• id (unsigned integer)

  The suspension's identifier.

• with - optional

  The groups of fields to be returned with the object.

  An array of strings.

  No values are supported at the moment.

  This array cannot contain duplicate values.

  Defaults to [] if not specified.

Returns

• comment (string)

  A short description of the suspension. This comment will be rewritten to the service's events journal when the suspension starts.

• end_timestamp (number)

  The Unix timestamp of the end of the suspension.

• id (unsigned integer)

  The suspension's identifier.

• service_id (unsigned integer)

  The suspended service ID.

• start_timestamp (number)

  The Unix timestamp of the beginning of the suspension.

Authorization

This method can be called by read-only users.

<<