Product Catalog Open API - GET /sn_prd_pm_adv/catalogmanagement/productspecification/{specificationI

ravarma · ‎05-02-2024

Hello Community,

Could you explain the importance of the resourceSpecification and serviceSpecification parameters in the GetProductSpecificationByID Product Catalog Open API (https://docs.servicenow.com/bundle/washingtondc-api-reference/page/integrate/inbound-rest/concept/pr...)? Also, which related list in the Product Specification object contains the data for these two parameters?

"resourceSpecification": [
  {
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "name": "String",
    "version": "String"
  }
]

"serviceSpecification": [
  {
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "name": "String",
    "version": "String"
  }
]

ShashankInamdar · ‎05-04-2024

Hi @ravarma ,

The serviceSpecification and resourceSpecification returned in the GET call for Product Spec by Id, are the Service Specs and Resource Specs directly in a relationship with the Product Specification in question.

The Related List where you will find them are under the 'Specification Relationships'.

Let's take an example -

In the below Catalog Model, SD-WAN Edge Device v2 is a Product Specification and in a direct relationship (in the red box) with 2 Service Specs - SD WAN Optimization Service & SD-WAN Routing AND with 1 Resource Spec - Customer Premise SD-WAN Router.

This information can be found under the Related List as shown below -

And on making the GET API call, the response payload is as below. You will notice the response payload returns 2 Service Specs and 1 Resource Specs.

{
  "id": "39b627aa53702010cd6dddeeff7b1202",
  "name": "SD-WAN Edge Device",
  "displayName": "SD-WAN Edge Device v2",
  "version": "",
  "internalVersion": "2",
  "internalId": "39b627aa53702010cd6dddeeff7b1202",
  "description": "SD-WAN Edge Device",
  "lastUpdate": "2025-06-16 03:15:00",
  "validFor": {
    "startDateTime": "2025-06-05",
    "endDateTime": "2030-07-05"
  },
  "serviceSpecification": [
    {
      "id": "16d79ec3532520103b6bddeeff7b12a6",
      "name": "SD WAN Optimization Service",
      "version": "",
      "internalVersion": "1",
      "internalId": "16d79ec3532520103b6bddeeff7b12a6"
    },
    {
      "id": "bf65eadc1b7420106ba59acf034bcb57",
      "name": "SD-WAN Routing",
      "version": "",
      "internalVersion": "1",
      "internalId": "bf65eadc1b7420106ba59acf034bcb57"
    }
  ],
  "productSpecificationRelationship": [],
  "resourceSpecification": [
    {
      "id": "493fa60b536520103b6bddeeff7b12b6",
      "name": "Customer Premise SD-WAN Router",
      "version": "",
      "internalVersion": "1",
      "internalId": "493fa60b536520103b6bddeeff7b12b6"
    }
  ],
  "productSpecCharacteristic": [
    {
      "productSpecCharacteristicValue": [
        {
          "value": "Advance",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Base",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Premium",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Routing",
      "description": "Routing",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2023-12-27 21:08:20"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "Virtual",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Physical",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "CPE Type",
      "description": "CPE Type",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2023-12-27 21:11:16"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "ASR",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "ISR",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "CPE Model",
      "description": "CPE Model",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2023-12-27 21:11:54"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "Base",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Advance",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Premium",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "WAN Optimization",
      "description": "WAN Optimization",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2023-12-27 21:10:28"
      }
    },
    {
      "productSpecCharacteristicValue": [],
      "name": "CPE Id",
      "description": "CPE Id",
      "valueType": "single_line_text",
      "validFor": {
        "startDatetime": "2024-02-03 17:50:26"
      }
    },
    {
      "productSpecCharacteristicValue": [],
      "name": "Network Site",
      "description": "Network Site sys_id",
      "valueType": "single_line_text",
      "validFor": {
        "startDatetime": "2022-08-04 21:06:10"
      }
    }
  ],
  "status": "published"
}

Hope this helps. Please mark it as a solution if this addressed your question.

Regards

Shashank

View solution in original post

ShashankInamdar · ‎05-04-2024