Open APIs

 View Only
  • 1.  Conflict between two specifications: Export handling

    TM Forum Member
    Posted Dec 18, 2019 09:31
    Hello,
    I'm working with TMF633 but, by reading TMF631, I have the feeling that we have different directions related to the Export (and as consequence Import) handling:

    As per TMF633, message format for Export Job should be:

    ==> POST {apiRoot}/exportJob (page 86 of TMF633)
    and, the element to be exported, would be targeted by the combination of:
    - Path: Containing address of element to be exported
    - Query: Containing filters (if required) to be applied over the element pointed by path.


    but, as per TMF631 (page 15), we see that the export Jobs should be created on top of the element being exported:
    ==> POST {apiRoot}/catalogManagement/catalog/{myCatalog}/exportJob
    and, the element to be exported, would be targeted by the combination of:
    - Path: Containing address of element to be exported. Coincides with the address in the request itself.
    - Query: Containing filters (if required) to be applied over the element pointed by path.
    And here, the shortcut: {apiRoot}/exportJob could be used for browsing over the status of the Job.


    So, which one is the official way forward?
    Regards.

    ------------------------------
    Marcos Donato da Silva
    Ericsson Inc.
    ------------------------------


  • 2.  RE: Conflict between two specifications: Export handling

    TM Forum Member
    Posted Dec 18, 2019 11:40
    Hi Marcos
    In the future, all the Catalog APIs (service, product, resource, entity) will share the same common definition of ImportJob and ExportJob, so there will be no inconsistency.
    The current (in progress) definition for ExportJob says:
    • Path: URL of the root resource acting as the source for streaming content to the file specified by the export job
    • Query: Used to scope the exported data
    And an example might be: 
    "path": "https://mycsp.com:8080/tmf-api/resourceCatalogManagement/v4/Catalog/3830",
    "query": "category.id=7757",

    In this example, the export should take all data from the catalog whose ID is 3830, where the category ID is 7757. This might (for example) bring all Physical Router specifications.

    Hope it helps


    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------