cURL 要求

次の例では、ID a1b23456c7de8a90f0123456gh789ij のサービスカテゴリを削除します。メッセージング付きのステータスコードを返します。

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
  --request DELETE \
  --header "Accept:application/json" \
  --user 'user:password'

"externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]

"modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]

"serviceCandidate": [
 {
  "id": "String",
  "href": "String",
  "name": "String",
  "@referredType": "String",
  "version": "String" 
 }
]

cURL 要求

次の例では、GET 操作を呼び出して、サービスカテゴリ [sn_prd_pm_specification_category] テーブル内のすべてのサービスカテゴリレコードのリストを返します。

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory" \
  --request GET \
  --header "Accept:application/json" \
  --user 'user:password'
``

応答本文。

{
  "id": "a1b23456c7de8a90f0123456gh789ij",
  "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/a2a68216d9ce2a90f87718429ae503dd",
  "name": "Cloud Services",
  "serviceCandidate": [
    {
      "id": "14fbd5ead902ea90f87718429ae503f7",
      "href": "api/sn_tmf_api/catalogmanagement/serviceSpecification/14fbd5ead902ea90f87718429ae503f7",
      "version": "1",
      "name": "servicenow",
      "@referredType": "ServiceCategory"
    }
  ],
  "modelCategory": [
    {
      "id": "a1d5bc14c3031000b959fd251eba8f5f",
      "name": "Business Service"
    }
  ],
  "externalIdentifier": [
    {
      "id": "1234234312",
      "owner": "TMF200000123233"
    }
  ],
  "isRoot": "true"
}

"externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]

"modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]

"serviceCandidate": [
 {
  "id": "String",
  "href": "String",
  "name": "String",
  "@referredType": "String",
  "version": "String" 
 }
]

cURL 要求

次の例では、GET 操作を呼び出して、指定された ID a2a68216d9ce2a90f87718429ae503dd に従って特定のサービスカテゴリレコードを返します。

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
  --request GET \
  --header "Accept:application/json" \
  --user 'user:password'

応答本文。

{
  "id": "a2a68216d9ce2a90f87718429ae503dd",
  "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/a1b23456c7de8a90f0123456gh789ij",
  "name": "Cloud Services",
  "serviceCandidate": [
    {
      "id": "a1b23456c7de8a90f0123456gh789ij",
      "href": "api/sn_tmf_api/catalogmanagement/serviceSpecification/a1b23456c7de8a90f0123456gh789ij",
      "version": "1",
      "name": "servicenow",
     

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

"serviceSpecificationRelationship": [
  {
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "relationshipType": "String",
    "validFor": {Object},
    "version": "String"
  }
]

"validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}

"specCharacteristic": [
  {
    "characteristicValueSpecification": [Array],
    "description": "String",
    "name": "String",
    "validFor": {Object},
    "valueType": "String"
  }
]

"characteristicValueSpecification": [
  {
    "value": "String"
  }
]

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

cURL 要求

この例では、すべてのサービス仕様を取得します。

curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification" \
--user 'username':'password'

応答本文。

[
   {
      "id": "16d79ec3532520103b6bddeeff7b12a6",
      "name": "SD WAN Optimization Service",
       "externalSystem": "Salesforce - TMF633",
      "description": "SD WAN Optimization Service",
      "lastUpdate": "2022-01-23 22:48:55",
      "validFor": {
         "startDateTime": "2022-01-12",
         "endDateTime": "2027-02-11"
      },
      "serviceSpecificationRelationship": [
         {
            "id": "a1f5fe981bb420106ba59acf034bcb4f",
            "name": "Deduplication and Compression",
            "version": "1",
            "type": "rfs",
            "validFor": {
               "startDateTime": "2021-02-11",
               "endDateTime": "2027-02-11"
            }
         }
      ],
      "resourceSpecification": [],
      "serviceSpecCharacteristic": [
         {
            "name": "SSL Optimization",
            "description": "SSL Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-14 07:47:57"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "False",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "True",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "CIFS Optimization",
            "description": "CIFS Optimization Protocol",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-14 07:49:09"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "SMB1",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "SMB2",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         }
      ]
      "externalSource": "ABC-TMF633"
   },
   {
      "id": "31c5caff07266010a7955b7e0ad3006b",
      "name": "Firewall Administration",
      "description": "Firewall Administration",
      "lastUpdate": "2022-01-23 11:46:48",
      "validFor": {
         "startDateTime": "2021-11-22",
         "endDateTime": ""
      },
      "serviceSpecificationRelationship": [],
      "resourceSpecification": [
         {
            "id": "3546463307666010a7955b7e0ad3005d",
            "name": "Cisco Firewall Management system",
            "version": "1"
         }
      ],
      "serviceSpecCharacteristic": [
         {
            "name": "Firewall Administration CPE Model",
            "description": "Firewall Administration CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-02-20 00:55:37"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "2100 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "4100 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "7300 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "9300 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
    "externalSource": "ABC-TMF633"
         },
         {
            "name": "Firewall Administration CPE Type",
            "description": "Firewall Administration CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-02-20 00:53:45"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Configuration and Policy backup",
            "description": "Configuration and Policy backup",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-21 10:46:02"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Weekly",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Monthly",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Daily",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Remote CLI troubleshoot support",
            "description": "Remote CLI troubleshoot support",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-21 10:45:38"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Standard support",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium support",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Basic support",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Firewall Administration CPE ID",
            "description": "Firewall Administration CPE ID",
            "valueType": "single_line_text",
            "validFor": {
               "startDatetime": "2022-02-20 00:57:50"
            },
            "productSpecCharacteristicValue": []
         }
      ]
   }
]

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

"serviceSpecificationRelationship": [
  {
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "relationshipType": "String",
    "validFor": {Object},
    "version": "String"
  }
]

"validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}

"specCharacteristic": [
  {
    "characteristicValueSpecification": [Array],
    "description": "String",
    "name": "String",
    "validFor": {Object},
    "valueType": "String"
  }
]

"characteristicValueSpecification": [
  {
    "value": "String"
  }
]

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

cURL 要求

この例では、ファイアウォールサービスのサービス仕様を取得します。

curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification/31c5caff07266010a7955b7e0ad3006b" \
--user 'username':'password'

応答本文。

{
   "id": "31c5caff07266010a7955b7e0ad3006b",
   "name": "Firewall Administration",
   "description": "Firewall Administration",
   "externalSystem": "Salesforce - TMF633",
   "lastUpdate": "2022-01-23 11:46:48",
   "validFor": {
      "startDateTime": "2021-11-22",
      "endDateTime": ""
   },
   "serviceSpecificationRelationship": [],
   "resourceSpecification": [
      {
         "id": "3546463307666010a7955b7e0ad3005d",
         "name": "Cisco Firewall Management system",
         "version": "1"
      }
   ],
   "serviceSpecCharacteristic": [
      {
         "name": "Firewall Administration CPE Model",
         "description": "Firewall Administration CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-02-20 00:55:37"
         },
         "productSpecCharacteristicValue": [
            { "value": "2100 series", "validFor": { "startDateTime": "" } },
            { "value": "4100 series", "validFor": { "startDateTime": "" } },
            { "value": "7300 series", "validFor": { "startDateTime": "" } },
            { "value": "9300 series", "validFor": { "startDateTime": "" } }
         ]
      },
      {
         "name": "Firewall Administration CPE Type",
         "description": "Firewall Administration CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-02-20 00:53:45"
         },
         "productSpecCharacteristicValue": [
            { "value": "Physical", "validFor": { "startDateTime": "" } },
            { "value": "Virtual", "validFor": { "startDateTime": "" } }
         ]
      },
      {
         "name": "Configuration and Policy backup",
         "description": "Configuration and Policy backup",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-21 10:46:02"
         },
         "productSpecCharacteristicValue": [
            { "value": "Weekly", "validFor": { "startDateTime": "" } },
            { "value": "Monthly", "validFor": { "startDateTime": "" } },
            { "value": "Daily", "validFor": { "startDateTime": "" } }
         ]
      },
      {
         "name": "Remote CLI troubleshoot support",
         "description": "Remote CLI troubleshoot support",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-21 10:45:38"
         },
         "productSpecCharacteristicValue": [
            { "value": "Standard support", "validFor": { "startDateTime": "" } },
            { "value": "Premium support", "validFor": { "startDateTime": "" } },
            { "value": "Basic support", "validFor": { "startDateTime": "" } }
         ]
      },
      {
         "name": "Firewall Administration CPE ID",
         "description": "Firewall Administration CPE ID",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2022-02-20 00:57:50"
         },
         "productSpecCharacteristicValue": []
      }
   ],
   "externalSource": "ABC-TMF633"
}

"externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]

"modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]

"serviceCandidate": [
 {
  "@referredType": "String",
  "href": "String",
  "id": "String",
  "name": "String",
  "version": "String" 
 }
]

"externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]

"modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]

"serviceCandidate": [
 {
  "@referredType": "String",
  "href": "String",
  "id": "String",
  "name": "String",
  "version": "String" 
 }
]

cURL 要求

次の例では、サービスカテゴリの名前、バージョン、サービス候補、モデルカテゴリ、および外部識別子情報を更新します。

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
  --request PATCH \
  --header "Accept:application/json" \
  --header "Content-Type:application/json" \
  --data '{
    "name": "Cloud Services",
    "version": "1.0",
    "serviceCandidate": [
      {
        "id": "a1b23456c7de8a90f0123456gh789ij",
        "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
        "version": "3.2",
        "name": "Cloud Services",
        "@referredType": "ServiceCategory"
      }
    ],
    "modelCategory": [
      {
        "id": "b2d5bc14c3031000b959fd251eba8f96",
        "name": "model"
      }
    ],
    "externalIdentifier": {
      "id": "1234234312",
      "owner": "TMF200000123233"
    },
    "isRoot": true
  }' \
  --user 'user:password

応答本文。

{
  "name": "Cloud Services",
  "version": "1.0",
  "serviceCandidate": [
    {
      "id": "a1b23456c7de8a90f0123456gh789ij",
      "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
      "version": "3.2",
      "name": "Cloud Services",
      "@referredType": "ServiceCategory"
    }
  ],
  "modelCategory": [
    {
      "id": "b2d5bc14c3031000b959fd251eba8f96",
      "name": "model"
    }
  ],
  "externalIdentifier": {
    "id": "1234234312",
    "owner": "TMF200000123233"
  },
  "isRoot": true,
  "id": "8138241b1caaaa10f87703c075c809fe",
  "href": "api/sn_tmf_api/catalogmanagement/serviceCategory/8138241b1caaaa10f87703c075c809fe"
}

"externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]

"modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]

"serviceCandidate": [
 {
  "id": "String",
  "href": "String",
  "name": "String",
  "@referredType": "String",
  "version": "String" 
 }
]

"externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]

"modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]

"serviceCandidate": [
 {
  "id": "String",
  "href": "String",
  "name": "String",
  "@referredType": "String",
  "version": "String" 
 }
]

cURL 要求

次の例では、POST を呼び出して、要求本文に指定された詳細に従って新しいサービスカテゴリレコードを作成します。

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory" \
  --request POST \
  --header "Accept:application/json" \
  --header "Content-Type:application/json" \
  --user 'user:password' \
  --data '{
    "name": "Cloud Services",
    "version": "1.0",
    "serviceCandidate": [
      {
        "id": "a1b23456c7de8a90f0123456gh789ij",
        "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
        "version": "3.2",
        "name": "Cloud Services",
        "@referredType": "ServiceCategory"
      }
    ],
    "modelCategory": [
      {
        "id": "b2d5bc14c3031000b959fd251eba8f96",
        "name": "model"
      }
    ],
    "externalIdentifier": {
      "id": "1234234312",
      "owner": "TMF200000123233"
    },
    "isRoot": true
  }'

応答本文。

{
  "name": "Cloud Services",
  "version": "1.0",
  "serviceCandidate": [
    {
      "id": "a1b23456c7de8a90f0123456gh789ij",
      "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
      "version": "3.2",
      "name": "Cloud Services",
      "@referredType": "ServiceCategory"
    }
  ],
  "modelCategory": [
    {
      "id": "b2d5bc14c3031000b959fd251eba8f96",
      "name": "model"
    }
  ],
  "externalIdentifier": {
    "id": "1234234312",
    "owner": "TMF200000123233"
  },
  "isRoot": true,
  "id": "8138241b1caaaa10f87703c075c809fe",
  "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/8138241b1caaaa10f87703c075c809fe"
}

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

"serviceSpecificationRelationship": [
  {
    "id": "String",
    "internalVersion": "String",
    "relationshipType": "String",
    "validFor": {Object},
    "version": "String"
  }
]

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

"specCharacteristic": [
  {
    "characteristicValueSpecification": [Array],
    "description": "String",
    "name": "String",
    "validFor": {Object},
    "valueType": "String"
  }
]

"characteristicValueSpecification": [
  {
    "value": "String"
  }
]

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

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

"serviceSpecificationRelationship": [
  {
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "relationshipType": "String",
    "validFor": {Object},
    "version": "String"
  }
]

"validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}

"specCharacteristic": [
  {
    "characteristicValueSpecification": [Array],
    "description": "String",
    "name": "String",
    "validFor": {Object},
    "valueType": "String"
  }
]

"characteristicValueSpecification": [
  {
    "value": "String"
  }
]

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

"validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}

cURL 要求

この例では、ファイアウォールサービスのサービス仕様を作成します。

curl "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"externalId\": \"7655\",
   \"name\": \"Firewall Service\",
   \"description\": \"This service specification describes a firewall service that can be deployed in customer-premises equipment.\",
   \"validFor\": {
      \"startDateTime\": \"2017-08-23T00:00\",
      \"endDateTime\": \"2021-03-25T00:00\"
   },
   \"lastUpdate\": \"2020-08-15T00:00\",
   \"externalSource\": \"ABC-TMF633\",
   \"resourceSpecification\": [
      {
         \"id\": \"af66e551c32f10105252716b7d40dd52\",
         \"name\": \"Firewall\"
      }
   ],
   \"specCharacteristic\": [
      {
         \"name\": \"Edge\",
         \"description\": \"This characteristic describes the operating system run by the service\",
         \"valueType\": \"choice\",
         \"validFor\": {
            \"startDateTime\": \"2017-08-12T00:00\",
            \"endDateTime\": \"2021-03-07T00:00\"
         },
         \"characteristicValueSpecification\": [
            {
               \"value\": \"Android KitKat\"
            }
         ]
      }
   ],
   \"serviceSpecRelationship\": [
      {
         \"relationshipType\": \"composed_of\",
         \"id\": \"65033023ebdb30107ee5302698522849\",
         \"validFor\": {
            \"startDateTime\": \"2017-08-25T00:00\",
            \"endDateTime\": \"2021-03-25T00:00\"
         }
      }
   ],
   \"@type\": \"ResourceFacingServiceSpecification\"
}" \
--user 'username':'password'

応答本文。

{
   "id": "21a7ee64c32310105253716b8d40dd60",
   "name": "Firewall Service",
   "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.",
   "validFor": {
      "startDateTime": "2017-08-23T00:00",
      "endDateTime": "2021-03-25T00:00"
   },
   "lastUpdate": "2020-08-15T00:00",
   "externalSource": "ABC-TMF633",
   "resourceSpecification": [
      {
         "id": "af66e551c32f10105252716b7d40dd52",
         "name": "Firewall"
      }
   ],
   "specCharacteristic": [
      {
         "name": "Edge",
         "description": "This characteristic describes the operating system run by the service",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-08-12T00:00",
            "endDateTime": "2021-03-07T00:00"
         },
         "characteristicValueSpecification": [
            {
               "value": "Android KitKat"
            }
         ]
      }
   ],
   "serviceSpecRelationship": [
      {
         "relationshipType": "composed_of",
         "id": "65033023ebdb30107ee5302698522849",
         "validFor": {
            "startDateTime": "2017-08-25T00:00",
            "endDateTime": "2021-03-25T00:00"
         }
      }
   ],
   "@type": "ResourceFacingServiceSpecification"
}