ServiceType - Available service types.
WSDL: https://api.cloudmonit.pl/2.0.0/wsdl/ServiceType.wsdl
JSON: https://api.cloudmonit.pl/2.0.0/json/ServiceType.json
This module can be used to obtain information about available service types.
# json request
{"module":"ServiceType","method":"Find","auth":{"login":"user","password":"pass"}}
# response.data
{"elements":[
{"name":"http","id":1,"prefix":"http://"}, # type IDs obtained here are required when creating a new service
{"name":"smtp-helo","id":2,"prefix":"smtp://"},
{"name":"https","id":5,"prefix":"https://"},
{"name":"ping","id":7,"prefix":"ping://"}
],"total":4}}
This method allows you to fetch information about selected ServiceType objects.
The account ID. Required if you want to find the services usage and you are a partner (for users, their account is assumed).
Filters to apply to the results.
An array of objects, each containg the fields:
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.
The field to filter the results by.
Allowed values are: id, name, prefix.
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.
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.
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.
Fields to order the results by, starting from the most significant.
An array of objects, each containg the fields:
The ordering direction, "ascending" or "descending".
Allowed values are: ascending, descending.
Defaults to "ascending" if not specified.
The field to order by. If not specified, the results can be returned in any order.
Allowed values are: id, name, prefix.
Maximum array length: 10.
The groups of fields to be returned with each object.
An array of strings.
Allowed values are: usage.
This array cannot contain duplicate values.
Defaults to [] if not specified.
An array of objects, each containg the fields:
The type's identifier.
Whether you can create more services of this type.
You have to include usage in the with argument to fetch this field.
The service type's name.
The service type prefix, like "http://". If you specify the url or ip service feature, you should omit this prefix.
The maximum number of services of the type that the account is allowed to create.
You have to include usage in the with argument to fetch this field.
The number of services of the type that the account has.
You have to include usage in the with argument to fetch this field.
The total number of results (not including pagination).
This method can be called by read-only users.
Returns the JSON or WSDL specification of the ServiceType API module.
This method is meant for internal usage in API clients. Unless you are writing one, you probably do not need it.
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.
The specification of the module.
The specification format used.
Allowed values are: json, wsdl.
This method can be called by read-only users.
This method allows you to get information about a single ServiceType object.
The account ID. Required if you want to find the services usage and you are a partner (for users, their account is assumed).
The type's identifier.
The groups of fields to be returned with the object.
An array of strings.
Allowed values are: features, usage.
This array cannot contain duplicate values.
Defaults to [] if not specified.
You have to include features in the with argument to fetch this field.
An array of objects, each containg the fields:
Whether the feature is considered an "advanced" one. Informational only.
The default value for the feature.
The feature description / label.
The feature identifier.
Specification of the suggested interactor (widget, form field etc.) to edit the feature with.
An object containing the following fields:
An array of objects, each containg the fields:
The label for the value.
The feature value.
The interactor type.
Allowed values are: checkbox, percent, regex, select, text, textarea.
The maximum allowed value of the feature (for types "int" and "numeric")
The maximum allowed length of the feature's value.
The minimal value of the feature (for types "int" and "numeric")
The minimal length of the feature's value.
Whether the feature can have a NULL value (regardless of any other validations)
An array of the allowed values of the feature.
An array of strings.
A Perl regular expression that the feature's value must match (without "/" at the beginning and end)
The feature type. If not specified, any string will do. "int" is a signed integer, "numeric" is any number, "bool" is 0 or 1, "regex" is a Perl regular expression (without the "/" at the beginning and end).
Allowed values are: bool, int, numeric, regex.
The type's identifier.
Whether you can create more services of this type.
You have to include usage in the with argument to fetch this field.
The service type's name.
The service type prefix, like "http://". If you specify the url or ip service feature, you should omit this prefix.
The maximum number of services of the type that the account is allowed to create.
You have to include usage in the with argument to fetch this field.
The number of services of the type that the account has.
You have to include usage in the with argument to fetch this field.
This method can be called by read-only users.