Plan Filters

Resource URI

/packages/{packageId}/plans/{planId}/services/{serviceId}/endpoints/{endpointId}/methods/{methodId}/responseFilter

Items in curly braces represent variables.

Description

A plan filter represents the relationship between a plan and a response filter. It is created when a response filter is attached to a plan method.

Resource Schema

Property	Characteristics
id	Type	string
	Sub-type
	Create Rule	Ignored
	Update Rule	Required (if not in context)
	Fetch Rule	Implicit
	Description	Object identifier.
name	Type	string
	Sub-type
	Create Rule	Required
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Method name.
created	Type	string
	Sub-type	datetime
	Create Rule	Ignored
	Update Rule	Ignored
	Fetch Rule	Implicit
	Description	Date/time the object was created.
updated	Type	string
	Sub-type	datetime
	Create Rule	Ignored
	Update Rule	Ignored
	Fetch Rule	Implicit
	Description	Date/time the object was updated.
notes	Type	string
	Sub-type
	Create Rule	Required
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Method name.
xmlFilterFields	Type	string
	Sub-type
	Create Rule	Ignored
	Update Rule	Ignored
	Fetch Rule	Explicit
	Description	Fields to strip from the response body of an XML response.
jsonFilterFields	Type	string
	Sub-type
	Create Rule	Ignored
	Update Rule	Ignored
	Fetch Rule	Explicit
	Description	Fields to strip from the response body of a JSON response.

fetch all [GET]

Retrieves the Plan Response Filter, returning a Plan Response Filter

Parameters

Parameter	Required	Type	Description
packageId	true	string	Package identifier.
planId	true	string	Plan identifier.
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
methodId	true	string	Method identifier.
fields	false	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter	false	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort	false	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\|desc)\]>\[,...\]\[&sort=...\]
limit	false	int	Number of objects to return in the result. Defaults to 100.
offset	false	int	0-based index of first object in the list to return. Defaults to 0.
indent	false	boolean	When set to true, responses are indented for better readability.

Returns

Success

PlanResponseFilter as identified If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9/plans/9c0e6072-b6a8-4085-877b-e3fb1c71bc73/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/methods/9f42d173-42f8-4862-b3e8-826e9de55ecd/responseFilter' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "id": "5dc206db-49cb-4893-9d07-cfc131dfa66e",
        "created": "2013-10-28T03:04:51.000+0000",
        "updated": "2014-01-03T07:48:14.000+0000",
        "name": "tellus nulla ut",
        "xmlFilterFields": "dictumst etiam",
        "notes": "rhoncus mauris enim leo",
        "jsonFilterFields": "tempor"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9/plans/9c0e6072-b6a8-4085-877b-e3fb1c71bc73/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/methods/9f42d173-42f8-4862-b3e8-826e9de55ecd/responseFilter' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" 

Response

[
    {
        "id": "4bbff54e-ff04-4458-ab8d-fb1484fae52d",
        "created": "2014-03-05T22:54:13.000+0000",
        "updated": "2013-10-03T19:25:39.000+0000",
        "name": "congue",
        "notes": "mauris non ligula pellentesque"
    }
]

create [POST]

Creates a new PlanResponseFilter in the given Plan Method.

Parameters

Parameter	Required	Type	Description
packageId	true	string	Package identifier.
planId	true	string	Plan identifier.
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
methodId	true	string	Method identifier.
planResponseFilter	true	object	Plan Response Filter object

Returns

Success

PlanResponseFilter as set If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9/plans/9c0e6072-b6a8-4085-877b-e3fb1c71bc73/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/methods/9f42d173-42f8-4862-b3e8-826e9de55ecd/responseFilter' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"id":"d22c7a46-8a07-461e-938a-1fd6420d917c","updated":"2014-04-09T15:17:19.000+0000","created":"2013-08-30T11:49:08.000+0000","name":"rhoncus","xmlFilterFields":"posuere felis sed","notes":"primis","jsonFilterFields":"aliquam augue"}

Response

[
    {
        "id": "2e476613-dc3f-44ed-9c59-ed972e553300",
        "created": "2014-04-09T14:18:58.000+0000",
        "updated": "2013-08-14T17:23:19.000+0000",
        "name": "accumsan tortor quis",
        "xmlFilterFields": "magna vulputate luctus cum",
        "notes": "faucibus",
        "jsonFilterFields": "volutpat"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9/plans/9c0e6072-b6a8-4085-877b-e3fb1c71bc73/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/methods/9f42d173-42f8-4862-b3e8-826e9de55ecd/responseFilter' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"id":"5517b766-9826-4814-9fcd-ed06fa17ba99","updated":"2014-04-24T15:17:39.000+0000","created":"2013-08-11T08:41:43.000+0000","name":"adipiscing molestie hendrerit at","notes":"enim in tempor turpis"}

Response

[
    {
        "id": "55edccfb-f273-453a-b539-e86690edd703",
        "created": "2013-12-20T20:15:20.000+0000",
        "updated": "2014-06-07T02:53:57.000+0000",
        "name": "pede lobortis ligula sit",
        "notes": "fringilla rhoncus"
    }
]

update [PUT]

Updates the identified PlanResponseFilter.

Parameters

Parameter	Required	Type	Description
packageId	true	string	Package identifier.
planId	true	string	Plan identifier.
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
methodId	true	string	Method identifier.
responseFilter	true	object	ResponseFilter object

Returns

Success

PlanResponseFilter as set If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9/plans/9c0e6072-b6a8-4085-877b-e3fb1c71bc73/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/methods/9f42d173-42f8-4862-b3e8-826e9de55ecd/responseFilter' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"id":"0a434433-9b15-4625-84ac-d71610839e99","updated":"2013-12-25T03:25:33.000+0000","created":"2014-03-30T17:35:11.000+0000","name":"habitasse platea dictumst etiam","xmlFilterFields":"sem praesent","notes":"interdum in ante vestibulum","jsonFilterFields":"condimentum neque sapien placerat"}

Response

[
    {
        "id": "e2377adc-afa0-4a38-84e0-2fd39b725801",
        "created": "2013-07-22T13:32:57.000+0000",
        "updated": "2014-03-14T05:09:50.000+0000",
        "name": "pellentesque ultrices mattis odio",
        "xmlFilterFields": "in congue",
        "notes": "luctus rutrum nulla tellus",
        "jsonFilterFields": "fusce lacus purus"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9/plans/9c0e6072-b6a8-4085-877b-e3fb1c71bc73/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/methods/9f42d173-42f8-4862-b3e8-826e9de55ecd/responseFilter' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"id":"f9afeef6-64b9-4d09-9632-3e2c5cfb55fe","updated":"2013-10-20T18:15:51.000+0000","created":"2014-06-21T15:55:59.000+0000","name":"lorem","notes":"semper interdum"}

Response

[
    {
        "id": "53ab5a0c-609c-46eb-b883-a51b15be1581",
        "created": "2014-03-16T08:44:21.000+0000",
        "updated": "2014-07-09T09:40:23.000+0000",
        "name": "nec nisi",
        "notes": "id"
    }
]

delete [DELETE]

Deletes the identified PlanResponseFilter.

Parameters

Parameter	Required	Type	Description
packageId	true	string	Package identifier.
planId	true	string	Plan identifier.
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
methodId	true	string	Method identifier.

Returns

Success

Empty response

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9/plans/9c0e6072-b6a8-4085-877b-e3fb1c71bc73/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/methods/9f42d173-42f8-4862-b3e8-826e9de55ecd/responseFilter' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Request

curl -k 'https://api.mashery.com/v3/rest/packages/83cca97c-986b-468c-b277-525b633909a9/plans/9c0e6072-b6a8-4085-877b-e3fb1c71bc73/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9/methods/9f42d173-42f8-4862-b3e8-826e9de55ecd/responseFilter' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]