plan_filter.create
Description
Create a plan filter Please see Creating Objects for an overview of how the create method works.
NOTE:This method is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.
Parameters
plan_filter
An plan_filter object, as described by the object.describe call. If a field in the plan_filter object is ommitted, a default value will be used if possible. If extra fields are passed, they will be ignored.
Response
An plan_filter object, as described by the object.describe call. This is actual plan_filter that was created.
Examples
A Sample JSON-RPC plan_filter.create Request
{ "method":"plan_filter.create", "id":26, "params":[[{"plan":{"id":47}, "plan_method":{"id":168}, "response_filter":{"id":5}, "service_definition_method":{"id":9}}]] }
The JSON-RPC Response
{ "result": true, "error": null, "id": 1 }
Permissions Required
The user who owns the key used to authenticate the plan_filter.create call must be a member of one of the following roles
- Administrator
- API Manager
See authentication.
Errors
In addition to the standard json-rpc errors and authentication errors, application.fetch may also return these errors:
HTTP Status Code | JSON-RPC Code | Error Message | Description |
---|---|---|---|
400 | 1000 | Invalid Object | The object could not be created because the object would be invalid. See Validating Fields for details on the format of this error. |
400 | 1001 | Duplicate Object | The object could not be created because an object already exists with the same identifier. |
400 | 1002 | Field "x" is required. | The object could not be created because a required field was not specified. A field marked false for optional was not specified. The error object data will include the name of the missing field. |
500 | 2001 | Create Failed | The object could not be created. This is the error message of last resort for object creation and usually indicates a systems integration failure, invalid internal data, or a transient issue. These errors are logged by Mashery. |
403 | 4200 | This operation is not allowed for the service specified | The service specified does not allow key creation via the API. |
Docs Navigation
- API Documentation Portal
- IO Docs Definition
- Mashery API Documentation
- Mashery 3.0 API Guide
- Mashery 2.0 API Guide
- OAuth Supporting Methods
- Examples
- JSON RPC
- Authentication
- API Objects
- Fetching Objects
- Query Language
- Creating Objects
- Updating Objects
- Validating Fields
- Deleting Objects
- Applications
- General Object Methods
- Members
- Packages
- Plans
- Package Keys
- Keys
- Developer Classes
- Services
- Roles
- Mashery 2.0 Reporting API Guide
- Event Trigger API
- Differences between Roles and Portal Access Groups
- Managing a Portal Access Group Using Mashery V2 or V3 API
- Mashery Reporting Event Post API Guide
- Tips and Tricks
- Your Portal
- API Traffic Manager
- I/O Docs WSDL requirements