...
Self-Certification is based on the TM Forum Open API conformance profiles, it is the process by which an implementation is confirmed to support the standard definition of a TM Forum Open API. Currently available conformance profiles can be found through the following links:
TMF661 Trouble Ticket API Conformance Profile R16.5.0
- TMF660 Product Catalog API Conformance Profile R16.5.0
- TMF659 Customer Management API Conformance Profile R16.5.0
- TMF637 Product Inventory Management API Conformance Profile R16.5
- TMF645 Service Qualification API Conformance Profile R16.5
The TM Forum provides a set of scripts useful to self-certify your implementation of TM Forum Open API specifications. You will need to install and run the applicable API CTK. Currently there is a number of CTKs available for conformance testing and the list is steadily increasing. The following is a list of APIs which have currently CTKs available for conformance testing:
Trouble Ticket CTK (API REST Specification TMF661 - R16.5.0)
Product Catalog Management CTK (API REST Specification TMF660 - R16.5.0)
Customer Management CTK (API REST Specification TMF659 - R16.5.0)
Product Inventory Management CTK (API REST Specification TMF637 - R16.5.0)
Service Qualification CTK (API REST Specification TMF645 - R16.5.0)
The following instructions describe how to install an Open API CTK
...
The following is a complete example for the Trouble Ticket API:
...
Newman test report
Collection: TMForum - TroubleTicket API CTK
Iterations: 1
Description:
Requests:
Description:
Mean time per request: 6123 ms
Total tests that passed: 2
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 404 | 1 | 0 |
Description: retrieve a product offering
Mean time per request: 3675 ms
Total tests that passed: 2
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is an error | 1 | 0 |
Description: retrieve a product offering
Mean time per request: 4320 ms
Total tests that passed: 2
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present text/plain | 1 | 0 |
Status code is an error | 1 | 0 |
Description: create a trouble ticket
Mean time per request: 3863 ms
Total tests that passed: 5
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Status code is 201 | 1 | 0 |
Content-Type is present application/json | 1 | 0 |
Response contains ID | 1 | 0 |
Response contains all required fields | 1 | 0 |
POST Body Response equals Request Body | 1 | 0 |
Description: retrieve /troubleTickets
Mean time per request: 7652 ms
Total tests that passed: 5
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Response contains all required fields | 1 | 0 |
Response contains created resource | 1 | 0 |
Element contained equals previous creation | 1 | 0 |
Description: retrieve a troubleTicket
Mean time per request: 1300 ms
Total tests that passed: 6
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Response contains ID | 1 | 0 |
Response contains all required fields | 1 | 0 |
ID is correct | 1 | 0 |
Body Response equals previous creation | 1 | 0 |
Description: create a trouble ticket
Mean time per request: 1315 ms
Total tests that passed: 5
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Status code is 201 | 1 | 0 |
Content-Type is present application/json | 1 | 0 |
Response contains ID | 1 | 0 |
Response contains all required fields | 1 | 0 |
POST Body Response equals Request Body | 1 | 0 |
Description: retrieve /troubleTickets
Mean time per request: 5085 ms
Total tests that passed: 5
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Response contains all required fields | 1 | 0 |
Response contains created resource | 1 | 0 |
Element contained equals previous creation | 1 | 0 |
Description: retrieve a troubleTicket
Mean time per request: 4147 ms
Total tests that passed: 6
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Response contains ID | 1 | 0 |
Response contains all required fields | 1 | 0 |
ID is correct | 1 | 0 |
Body Response equals previous creation | 1 | 0 |
Description: retrieve troubleTickets
Mean time per request: 4481 ms
Total tests that passed: 7
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Response contains all required fields | 1 | 0 |
Response contains created resource 1 | 1 | 0 |
Element contained equals previous creation 1 | 1 | 0 |
Response contains created resource 2 | 1 | 0 |
Element contained equals previous creation 2 | 1 | 0 |
Description: retrieve tickets with high severity
Mean time per request: 2135 ms
Total tests that passed: 6
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Response contains all required fields | 1 | 0 |
Response does not contain created resource 2 | 1 | 0 |
Response contains created resource 1 | 1 | 0 |
Element contained equals previous creation 1 | 1 | 0 |
Description: retrieve tickets with connectivity problems
Mean time per request: 1560 ms
Total tests that passed: 6
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Response contains all required fields | 1 | 0 |
Response does not contain created resource 1 | 1 | 0 |
Response contains created resource 2 | 1 | 0 |
Element contained equals previous creation 2 | 1 | 0 |
Description: retrieve the product offering that are active
Mean time per request: 887 ms
Total tests that passed: 3
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Element contained equals previous creation | 1 | 0 |
Description: retrieve the product offering that are active
Mean time per request: 620 ms
Total tests that passed: 3
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Element contained equals previous creation | 1 | 0 |
Description: retrieve the product offering that are active
Mean time per request: 598 ms
Total tests that passed: 5
Total tests that failed: 0
Individual tests:
Test name | Pass count | Fail count |
---|---|---|
Content-Type is present application/json | 1 | 0 |
Status code is 200 | 1 | 0 |
Response contains created resource 1 | 1 | 0 |
Element contained equals previous creation | 1 | 0 |
Response does not contain created resource 2 | 1 | 0 |
When you have completed these tests successfully, please send your test results (html and json results files) to [email protected], as they will be posted to our TM Forum Self Certification Web Page.
...