Open APIs

 View Only

TMF 620 : Error Message for attribute selection for the fields that are not enabled for the same

  • 1.  TMF 620 : Error Message for attribute selection for the fields that are not enabled for the same

    Posted Dec 08, 2022 03:25

    Hi all,

    The TMF 620 doc does not specify on what should be the error message for the below case -

    {{URL}}/services/apexrest/{{namespace}}/tmforum/productopenapi/v1/catalog?fields=href

    here, we are trying to only fetch the field - 'href' for all the catalogs. In our implementation, we have disabled attribute selection and filtering on the field 'href', since its just the address of the object in our system and does not make much sense for being used as a filter or attribute to be fetched alone. So for this case we ignore the last part of the url -'fields=href' and send the response same as for -

    {{URL}}/services/apexrest/{{namespace}}/tmforum/productopenapi/v1/catalog

    which is -

    URL - {{URL}}/services/apexrest/{{namespace}}/tmforum/productopenapi/v1/catalog?fields=href

    Response -

    {

    "PageInfo": "Page 1 of 1",

    "PageSize": 50,

    "Result": [

    {

    "@referredType": "devopsimpkg19__Catalog__c",

    "description": "A category to hold all available cloud service offers",

    "href": "/services/apexrest/devopsimpkg19/tmforum/productopenapi/v1/catalog/a16B0000001rXQQIA2",

    "id": "217590bb-d7f3-ea0f-c25a-8594006f24b5",

    "isRoot": false,

    "lifecycleStatus": true,

    "name": "Cloud Servddices 189cc1bvb0",

    "validFor": {

    "endDateTime": "2024-03-25T00:00:00.000+0000",

    "startDateTime": "2020-08-24T00:00:00.000+0000"

    },

    "@type": "Catalog"

    },

    {

    "@referredType": "devopsimpkg19__Catalog__c",

    "description": "A category to hold all available cloud service offers",

    "href": "/services/apexrest/devopsimpkg19/tmforum/productopenapi/v1/catalog/a16B0000001rZh1IAE",

    "id": "a10208e5-b167-9090-e3fc-0234b945d7c1",

    "isRoot": false,

    "lifecycleStatus": true,

    "name": "Cloud Services retest Ak1stAug Nov23QQ2022",

    "validFor": {

    "endDateTime": "2024-03-25T00:00:00.000+0000",

    "startDateTime": "2020-08-24T00:00:00.000+0000"

    },

    "@type": "Catalog"

    },
    }

    Instead of sending the above response, seems like sending an error message as 'Bad Request' would be better. But we need a confirmation before we proceed to implement the same. Pls help us with the same.

    Thanks



    ------------------------------
    Nikita Soni
    Salesforce
    ------------------------------