Skip to content

# TMF OpenAPI specification

PLease check the complete specification here.

## API interaction

### OAuth token

See oauth.

### Request a protected API resource

Example: Get all Service Catalogs (check the `Authorization:Bearer` to be correct)

    curl -H "Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJhZG1pbiIsInNjb3BlIjpbIm9wZW5hcGkiLCJhZG1pbiIsInJlYWQiLCJ3cml0ZSJdLCJvcmdhbml6YXRpb24iOiJteW9yZ2FuaXp0aW9uIiwiZXhwIjoxNTc4NTA1MDcyLCJhdXRob3JpdGllcyI6WyJST0xFX01FTlRPUiIsIlJPTEVfQURNSU4iXSwianRpIjoiMTFlNGYxYTUtZDY0Ny00YzA1LWE0ZGMtYWFhYzUyMjk4YzMwIiwiY2xpZW50X2lkIjoib3NhcGlXZWJDbGllbnRJZE91dCJ9.gm7cKdusDrdMRkxEiFU5sENKGRC1xwVj2SgPRmE9xxx"  -H  "accept: application/json;charset=utf-8" -X GET "http://portal.openslice.eu/tmf-api/serviceCatalogManagement/v4/serviceCatalog"

response:

    [
      {
        "uuid": "9e186cd5-b2b2-4a06-b1d6-895720193bc9",
        "lastUpdate": "2019-12-19T10:45:55Z",
        "@baseType": "BaseEntity",
        "@schemaLocation": null,
        "@type": "ServiceCatalog",
        "href": null,
        "name": "Example Facility Services",
        "description": "Example Facility Services",
        "lifecycleStatus": "Active",
        "version": "1.0",
        "validFor": {
          "endDateTime": "2039-11-20T23:07:21Z",
          "startDateTime": "2019-11-20T23:07:21Z"
        },
        "relatedParty": null,
        "id": "9e186cd5-b2b2-4a06-b1d6-895720193bc9",
        "category": [
          {
            "@baseType": "org.etsi.osl.tmf.scm633.model.ServiceCategoryRef",
            "@schemaLocation": null,
            "@type": "org.etsi.osl.tmf.scm633.model.ServiceCategoryRef",
            "href": null,
            "name": "eMBB",
            "@referredType": null,
            "id": "ef2c90dd-b65e-4a9f-a9c3-427c9fb0219b"
          },
          {
            "@baseType": "org.etsi.osl.tmf.scm633.model.ServiceCategoryRef",
            "@schemaLocation": null,
            "@type": "org.etsi.osl.tmf.scm633.model.ServiceCategoryRef",
            "href": null,
            "name": "Generic Services",
            "@referredType": null,
            "id": "98b9adf1-a1d6-4165-855f-153ddc2131b1"
          }
        ]
      }
    ]