About Additional Query Parameters
This section lists some additional query parameters of GET request type that are not part of the OpenAPI specifications.
For the /productOrder and /serviceOrder request API paths, the list shows optional query parameters that can be supplied when accessing the TMF622 and TMF641 specifications.
Request API Paths | Query Parameter | Description |
/productOrder /serviceOrder |
id
|
This parameter is used when you want to retrieve an order based on order id. |
/productOrder /serviceOrder |
orderDate |
This parameter is used when you want to retrieve orders on a particular date. |
/productOrder /serviceOrder |
fromOrderDate |
This parameter is used when you want to retrieve orders from a particular date. |
/productOrder /serviceOrder |
toOrderDate |
This parameter is used when you need to retrieve orders until a particular date |
Note:
Theoffset
parameter that is defined for APIs in the OpenAPI
specification file is not implemented by OSM.
If the limit
parameter that is defined for APIs in the OpenAPI
specification is not used by the APIs, the default limit and maximum limit property
values from the instance specification file are picked.