EffectivityFilterResource

The following resources are applicable:

GET /effectivityfilters/{effectivityFilterId}

Retrieves a effectivity filter object (product leaf, product instance, or custom effectivity filter) by ID.

Request Parameters

name type description default
effectivityFilterId path the ID of the effectivity filter object (product leaf, product instance, or custom effectivity filter) to retrieve. n/a
$expand query OData expand clause used to expand collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query the OData order by n/a
$skip query number of items to skip to the start of this page n/a
$top query number of objects to return in this page n/a
effectivity query the OData filter including the effectivity filter to apply n/a

Response Codes

code condition
400 Returned when an invalid SCID is passed.
404 Returned when a effectivity filter object (product leaf, product instance, or custom effectivity filter) is not found for the given productInstanceId.

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)

GET /effectivityfilters/{effectivityFilterId}/primeCaptiveFilters

Retrieves list of prime captive filters either from Invoice or from P2C Component relations

Request Parameters

name type description default
effectivityFilterId path the ID of the effectivity filter object (product leaf, product instance, or custom effectivity filter) to retrieve. n/a
$expand query OData expand clause used to expand collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query the OData order by n/a
$skip query number of items to skip to the start of this page n/a
$top query number of objects to return in this page n/a
effectivity query the OData filter including the effectivity filter to apply n/a

Response Codes

code condition
400 Returned when an invalid SCID is passed.
404 Returned when a effectivity filter object (product leaf, product instance, or custom effectivity filter) is not found for the given productInstanceId.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /effectivityfilters/{effectivityFilterId}/filtersFromInvoice

Retrieves list of prime captive filters from Invoice

Request Parameters

name type description default
effectivityFilterId path the ID of the effectivity filter object (product leaf, product instance, or custom effectivity filter) for which the filters will be retrieved n/a
$expand query OData expand clause used to expand collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query the OData order by n/a
$skip query number of items to skip to the start of this page n/a
$top query number of objects to return in this page n/a
effectivity query the OData filter including the effectivity filter to apply n/a

Response Codes

code condition
400 Returned when an invalid SCID is passed.
404 Returned when a effectivity filter object (product leaf, product instance, or custom effectivity filter) is not found for the given productInstanceId.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /effectivityfilters/{effectivityFilterId}/componentFilters

Retrieves list of prime captive filters from P2C Component relations

Request Parameters

name type description default
effectivityFilterId path the ID of the effectivity filter object (product leaf, product instance, or custom effectivity filter) for which the filters will be retrieved n/a
$expand query OData expand clause used to expand collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query the OData order by n/a
$skip query number of items to skip to the start of this page n/a
$top query number of objects to return in this page n/a
effectivity query the OData filter including the effectivity filter to apply n/a

Response Codes

code condition
400 Returned when an invalid SCID is passed.
404 Returned when a effectivity filter object (product leaf, product instance, or custom effectivity filter) is not found for the given productInstanceId.

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)

GET /effectivityfilters/{effectivityFilterId}/asShipped

Retrieves a As Shipped data for given serial number

Request Parameters

name type description default
effectivityFilterId path the ID of the effectivity filter object (product leaf, product instance, or custom effectivity filter) to retrieve. n/a

Response Codes

code condition
400 Returned when an invalid SCID is passed.
404 Returned when a effectivity filter object (product leaf, product instance, or custom effectivity filter) is not found for the given productInstanceId.

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)

GET /effectivityfilters/{effectivityFilterId}/captive

Retrieves a As Shipped - captive data for given serial number

Request Parameters

name type description default
effectivityFilterId path the ID of the effectivity filter object (product leaf, product instance, or custom effectivity filter) to retrieve. n/a
collectionName query n/a

Response Codes

code condition
400 Returned when an invalid SCID is passed.
404 Returned when a effectivity filter object (product leaf, product instance, or custom effectivity filter) is not found for the given productInstanceId.

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)

GET /effectivityfilters/{effectivityFilterId}/product

Retrieves the product which is represented by the effectivity filter object (product leaf, product instance, or custom effectivity filter).

Request Parameters

name type description default
effectivityFilterId path the ID of the effectivity filter object (product leaf, product instance, or custom effectivity filter). n/a
$expand query OData expand clause used to expand collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query the OData order by n/a
$skip query number of items to skip to the start of this page n/a
$top query number of objects to return in this page n/a
effectivity query the OData filter including the effectivity filter to apply n/a

Response Codes

code condition
400 Returned when an invalid SCID is passed.
404 Returned when a effectivity filter object (product leaf, product instance, or custom effectivity filter) is not found for the given productInstanceId.

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)

GET /effectivityfilters/{effectivityFilterId}/topicRoots

Retrieves ISRootNodes of a given product identified by the product instance ID.

Request Parameters

name type description default
effectivityFilterId path The effectivity filter object (product leaf, product instance, or custom effectivity filter) ID whose instances to retrieve. n/a
$expand query The OData expand clause used to expand related objects and collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query The OData order by. n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the product node ID is not valid.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /effectivityfilters/{effectivityFilterId}/children

Retrieves children of a given product identified by its ID.

Request Parameters

name type description default
effectivityFilterId path The effectivity filter object (product leaf, product instance, or custom effectivity filter) ID whose instances to retrieve. n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the product node ID is not valid.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /effectivityfilters/{effectivityFilterId}/parentpath

Retrieves the parent path for the requested effectivity filter object (product leaf, product instance, or custom effectivity filter). The path is represented by a list starting from the top most (root) node with each node there after the child of the preceeding node. The lists ends with the node requested. The first element is the highest element in the structure that could be found which is either a root or has two parents (preventing further traversal of the structure).

Request Parameters

name type description default
effectivityFilterId path The effectivity filter object (product leaf, product instance, or custom effectivity filter) whose path to retrieve. n/a
$expand query The OData expand clause used to expand related objects and collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query The OData order by. n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the effectivity filter object (product leaf, product instance, or custom effectivity filter) ID is not valid.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

POST /effectivityfilters

Creates a new Filter.

Request Body

media type data type description
application/vnd.ptc.sc+json SCItem (JSON) The SCItem representing the filter to create.

Response Codes

code condition
415 Returned if the Content-Type is not application/vnd.ptc.sc+json;version=n

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)

PUT /effectivityfilters/{filterId}

Updates an existing filter.

Request Parameters

name type description default
filterId path The ID of the filter to be updated. n/a

Request Body

media type data type description
application/vnd.ptc.sc+json SCItem (JSON) The filter to be updated.

Response Codes

code condition
400 Returned when the content does not contain the correct filter data for the update or the filterId is not of valid ID format.
404 Returned when a filter is not found for the given filter ID.
415 Returned if the Content-Type is not application/vnd.ptc.sc+json;version=n

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)

DELETE /effectivityfilters/{filterId}

Deletes the specified filter.

Request Parameters

name type description default
filterId path The ID of the filter to be deleted. n/a

Response Codes

code condition
204 Returned if the filter was successfully deleted.
400 Returned when a filterId is not of valid ID format.
404 Returned when a filter is not found for the given filter ID.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

POST /effectivityfilters/remove

Delete a list of given filters.

Request Parameters

name type description default
Content-Type header The content type with the correct version parameter. n/a

Request Body

media type data type description
application/vnd.ptc.sc+json SCList (JSON) The SCList of filters to be deleted.

Response Codes

code condition
400 Returned when the content does not contain data or the filterId of any item in the SCList is not of valid ID format.
404 Returned when a filterId is not of valid ID format.
415 Returned if the Content-Type is not application/vnd.ptc.sc+json;version=1.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /effectivityfilters

Retrieves all filters for the current user.

Request Parameters

name type description default
$filter query -- Reserved for future use. -- n/a
$orderby query The OData order by n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /effectivityfilters/productidentifier

Retrieves valid filters for a given product identifier

Request Parameters

name type description default
productId query the ID of the effectivity filter object (product leaf, product instance, or custom effectivity filter) to retrieve. n/a

Response Codes

code condition
400 Returned when the filters are empty

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /effectivityfilters/get_all_ids

Retrieves all filter ids for the given user. This does not return serialized filters, it returns an SCList of ids.

Response Body

media type data type
application/vnd.ptc.sc+json array of object (JSON)

POST /effectivityfilters/find

Finds the SCEffectivityFilter for the current user with the filtering criteria matching the criteria of the passed filer.

Request Body

media type data type description
application/vnd.ptc.sc+json SCItem (JSON) - filter to check the criteria against.

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)