API Abrir Catálogo de serviços

Versão de lançamento: Zurich

Atualizado 31 de jul. de 2025

20 min. de leitura

. Catálogo de serviços aberto A API fornece endpoints para criar e recuperar especificações de serviço.

Use esta API para gerenciar informações do catálogo de serviços entre sistemas externos e o. ServiceNow AI Platform. . Catálogo de serviços aberto A API é um ServiceNow® Implementação da especificação REST da API do Catálogo de serviços do TM Forum. Esta implementação é baseada no Especificação REST da API do Catálogo de serviços TMF663 Versão 4 Outubro de 2020.

Esta API está incluída na aplicação Catálogo de produtos avançada, que está disponível no ServiceNow Store.

Esta API é fornecida no sn_prd_pm_adv namespace.

O usuário chamador deve ter a função sn_prd_pm_adv.catalog_integrator.

Esta API cria e atualiza dados nas tabelas a seguir.

Característica [sn_prd_pm_characteristic]
Opção de característica [sn_prd_pm_characteristic_option]
Especificação de serviço [sn_prd_pm_service_specification]
Relacionamento de especificação [sn_prd_pm_specification_relationship]

Catálogo de serviços aberto - OBTER /servicefication

Recupera uma lista de todas as especificações de serviço.

Formato de URL

URL padrão: /api/sn_prd_pm_adv/catalogmanagement/servicefication

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
Nenhum(a)

Tabela 2. Parâmetros de consulta
Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Tipo de dados: Cadeia de caracteres
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro. Tipo de dados: Número Padrão: 20 Máximo: 100
deslocamento	Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0
estado	Filtrar especificações de serviço por estado. Somente especificações com um estado correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: Cadeia de caracteres

Tabela 3. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 4. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum(a)

Tabela 5. Cabeçalhos de resposta
Cabeçalho	Descrição
Intervalo de conteúdo	Intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se `deslocamento: 2` e. `limite: 3` , o valor de Content-Rangeo cabeçalho é `itens 3-5` .
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Link	Contém os seguintes links para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Count	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 6. Códigos de status
Código do status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado na resposta (com paginação).
400	Solicitação incorreta. Possíveis motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
descrição	Descrição da especificação. Tipo de dados: Cadeia de caracteres
externalId	ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
id	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
internalId	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
InternalVersion	Versão da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
LastUpdate	Data em que a especificação foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
nome	Nome da especificação. Tipo de dados: Cadeia de caracteres
ResourceSpecification	Especificações de recursos para esta especificação de serviço. Tipo de dados: Matriz de objetos `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Initial_version ou external_id da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.internalId	Initial_version da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.internalVersion	External_version da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres
ResourceSpecification.version	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship	Relacionamentos desta especificação com outras especificações de serviço. Tipo de dados: Matriz de objetos `"serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	Initial_version ou external_id da especificação relacionada. Tipo de dados: Cadeia de caracteres
serviceSpecificationRelationship.internalId	Initial_version da especificação relacionada. Tipo de dados: Cadeia de caracteres
serviceSpecificationRelationship.internalVersion	Versão da especificação relacionada. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.RelationshipType	Tipo de relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.validFor	Intervalo de datas para o qual o relacionamento é válido. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ServiceSpecificationRelationship.validFor.endDateTime	Data de término do relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.validFor.startDateTime	Data de início do relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.version	External_version da especificação relacionada. Tipo de dados: Cadeia de caracteres
EspecCharacterística	Característica de especificação. Tipo de dados: Matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	Lista de valores possíveis da característica. Tipo de dados: Matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	Valor da característica. Tipo de dados: Cadeia de caracteres
specCharacteristic.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
specCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
SpecCharacteristic.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.valueType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ValidFor.endDateTime	Data de término da especificação. Tipo de dados: Cadeia de caracteres
ValidFor.startDateTime	Data de início da especificação. Tipo de dados: Cadeia de caracteres
versão	Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
.	Tipo de especificação. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera todas as especificações de serviço.

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

Corpo da resposta.

[
   {
      "id": "16d79ec3532520103b6bddeeff7b12a6",
      "name": "SD WAN Optimization Service",
      "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": ""
                  }
               }
            ]
         }
      ]
   },
   {
      "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": ""
                  }
               }
            ]
         },
         {
            "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": []
         }
      ]
   }
]

Catálogo de serviços aberto - OBTENHA /servicspecification/

Recupera uma especificação de serviço.

Formato de URL

URL padrão: /api/sn_prd_pm_adv/catalogmanagement/servicefication/

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
EspecificaçãoId	Sys_id da especificação de serviço a ser recuperada. Tipo de dados: Cadeia de caracteres Tabela: Especificação de serviço [sn_prd_pm_service_specification]

Tabela 8. Parâmetros de consulta
Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Se este parâmetro não for usado, todos os campos serão retornados. Tipo de dados: Cadeia de caracteres
estado	Filtrar especificações de serviço por estado. Somente especificações com um estado correspondente ao valor deste parâmetro são retornadas na resposta. Tipo de dados: Cadeia de caracteres

Tabela 9. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
Nenhum(a)

Cabeçalhos

Tabela 10. Cabeçalhos da solicitação
Cabeçalho	Descrição
Nenhum(a)

Tabela 11. Cabeçalhos de resposta
Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 12. Códigos de status
Código do status	Descrição
200	Solicitação processada com sucesso.
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. O registro associado ao ID não foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
descrição	Descrição da especificação. Tipo de dados: Cadeia de caracteres
externalId	ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
id	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
internalId	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
InternalVersion	Versão da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
LastUpdate	Data em que a especificação foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
nome	Nome da especificação. Tipo de dados: Cadeia de caracteres
ResourceSpecification	Especificações de recursos para esta especificação de serviço. Tipo de dados: Matriz de objetos `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Initial_version ou external_id da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.internalId	Initial_version da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.internalVersion	External_version da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres
ResourceSpecification.version	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship	Relacionamentos desta especificação com outras especificações de serviço. Tipo de dados: Matriz de objetos `"serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	Initial_version ou external_id da especificação relacionada. Tipo de dados: Cadeia de caracteres
serviceSpecificationRelationship.internalId	Initial_version da especificação relacionada. Tipo de dados: Cadeia de caracteres
serviceSpecificationRelationship.internalVersion	Versão da especificação relacionada. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.RelationshipType	Tipo de relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.validFor	Intervalo de datas para o qual o relacionamento é válido. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ServiceSpecificationRelationship.validFor.endDateTime	Data de término do relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.validFor.startDateTime	Data de início do relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.version	External_version da especificação relacionada. Tipo de dados: Cadeia de caracteres
EspecCharacterística	Característica de especificação. Tipo de dados: Matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	Lista de valores possíveis da característica. Tipo de dados: Matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	Valor da característica. Tipo de dados: Cadeia de caracteres
specCharacteristic.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
specCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
SpecCharacteristic.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.valueType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ValidFor.endDateTime	Data de término da especificação. Tipo de dados: Cadeia de caracteres
ValidFor.startDateTime	Data de início da especificação. Tipo de dados: Cadeia de caracteres
versão	Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
.	Tipo de especificação. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera uma especificação de serviço para um serviço de firewall.

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

Corpo da resposta.

{
   "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": ""
               }
            }
         ]
      },
      {
         "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": []
      }
   ]
}

Catálogo de serviços aberto - PUBLICAÇÃO/especificação de serviço

Cria uma especificação de serviço.

Formato de URL

URL padrão: /api/sn_prd_pm_adv/catalogmanagement/servicefication

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho
Nome	Descrição
Nenhum(a)

Tabela 14. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 15. Solicitar parâmetros do corpo (JSON)
Nome	Descrição
descrição	Obrigatório. Descrição da especificação. Tipo de dados: Cadeia de caracteres
externalId	ID externo da especificação do serviço. Se ambos externalIde. idfornecidos, eles devem se referir à mesma especificação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco Tabela: Especificação de serviço [sn_prd_pm_service_specification]
id	Initial_version ou external_id da especificação do serviço. Se ideste endpoint cria uma nova especificação com a versão 1. Se idfornecido, este endpoint cria uma nova versão da especificação fornecida. Se ambos externalIde. idfornecidos, eles devem se referir à mesma especificação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
InternalVersion	Versão da especificação do serviço. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco Tabela: Especificação de serviço [sn_prd_pm_service_specification]
LastUpdate	Data em que a especificação foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
nome	Obrigatório. Nome da especificação. Tipo de dados: Cadeia de caracteres
ResourceSpecification	Obrigatório. Especificações de recursos para esta especificação de serviço. Tipo de dados: Matriz de objetos `"resourceSpecification": [ { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Obrigatório. Initial_version ou external_id da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.internalVersion	External_version da especificação do recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ResourceSpecification.version	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ServiceSpecificationRelationship	Detalhes dos relacionamentos da especificação com outras especificações de serviço. Tipo de dados: Matriz de objetos `"serviceSpecificationRelationship": [ { "id": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	Necessário se estiver usando serviceSpecificationRelationshipparâmetro. Initial_version ou external_id da especificação relacionada. Tipo de dados: Cadeia de caracteres
serviceSpecificationRelationship.internalVersion	Versão da especificação relacionada. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ServiceSpecificationRelationship.RelationshipType	Necessário se estiver usando serviceSpecificationRelationshipparâmetro. Tipo de relacionamento. Valores válidos: pacotes composto_de Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.validFor	Intervalo de datas para o qual o relacionamento é válido. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ServiceSpecificationRelationship.validFor.endDateTime	Data de término do relacionamento. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ServiceSpecificationRelationship.validFor.startDateTime	Data de início do relacionamento. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ServiceSpecificationRelationship.version	External_version da especificação relacionada. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
EspecCharacterística	Característica de especificação. Tipo de dados: Matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	Obrigatório. Valores possíveis da característica. Tipo de dados: Matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	Obrigatório. Valor da característica. Tipo de dados: Cadeia de caracteres
specCharacteristic.description	Descrição da característica. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
specCharacteristic.name	Obrigatório. Nome da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
SpecCharacteristic.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
SpecCharacteristic.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
SpecCharacteristic.valueType	Obrigatório. Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Obrigatório. Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ValidFor.endDateTime	Data de término da especificação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
ValidFor.startDateTime	Data de início da especificação. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco
versão	Versão externa da especificação do serviço. A versão deve ser exclusiva para a cadeia de versões fornecida. Tipo de dados: Cadeia de caracteres Cadeia de caracteres em branco Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
.	Obrigatório. Tipo de especificação. Valores válidos: CustomerFacingServiceSpecification ResourceFacingServiceSpecification Tipo de dados: Cadeia de caracteres

Cabeçalhos

Tabela 16. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 17. Cabeçalhos de resposta
Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status
Código do status	Descrição
201	Solicitação processada com sucesso.
400	Solicitação Incorreta. Qualquer um dos seguintes motivos: Carga vazia. Carga inválida. Campo obrigatório ausente: <field name>

Parâmetros do corpo da resposta (JSON)


Nome	Descrição
descrição	Descrição da especificação. Tipo de dados: Cadeia de caracteres
externalId	ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
id	Versão inicial ou ID externo da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version ou external_id da tabela Especificação de serviço [sn_prd_pm_service_specification].
internalId	Versão inicial da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo initial_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
InternalVersion	Versão da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo Versão da tabela Especificação de serviço [sn_prd_pm_service_specification].
LastUpdate	Data em que a especificação foi atualizada pela última vez. Tipo de dados: Cadeia de caracteres
nome	Nome da especificação. Tipo de dados: Cadeia de caracteres
ResourceSpecification	Especificações de recursos para esta especificação de serviço. Tipo de dados: Matriz de objetos `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Initial_version ou external_id da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.internalId	Initial_version da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.internalVersion	External_version da especificação do recurso. Tipo de dados: Cadeia de caracteres
resourceSpecification.name	Nome da especificação do recurso. Tipo de dados: Cadeia de caracteres
ResourceSpecification.version	Versão da especificação do recurso. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship	Relacionamentos desta especificação com outras especificações de serviço. Tipo de dados: Matriz de objetos `"serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	Initial_version ou external_id da especificação relacionada. Tipo de dados: Cadeia de caracteres
serviceSpecificationRelationship.internalId	Initial_version da especificação relacionada. Tipo de dados: Cadeia de caracteres
serviceSpecificationRelationship.internalVersion	Versão da especificação relacionada. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.RelationshipType	Tipo de relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.validFor	Intervalo de datas para o qual o relacionamento é válido. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ServiceSpecificationRelationship.validFor.endDateTime	Data de término do relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.validFor.startDateTime	Data de início do relacionamento. Tipo de dados: Cadeia de caracteres
ServiceSpecificationRelationship.version	External_version da especificação relacionada. Tipo de dados: Cadeia de caracteres
EspecCharacterística	Característica de especificação. Tipo de dados: Matriz de objetos `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	Lista de valores possíveis da característica. Tipo de dados: Matriz de objetos `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	Valor da característica. Tipo de dados: Cadeia de caracteres
specCharacteristic.description	Descrição da característica. Tipo de dados: Cadeia de caracteres
specCharacteristic.name	Nome da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.validFor	Intervalo de datas para o qual a característica é válida. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
SpecCharacteristic.validFor.endDateTime	Data de término da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.validFor.startDateTime	Data de início da característica. Tipo de dados: Cadeia de caracteres
SpecCharacteristic.valueType	Tipo de valor da característica, como opção ou e-mail. Tipo de dados: Cadeia de caracteres
ValidFor	Intervalo de datas para o qual a especificação é válida. Tipo de dados: Objeto `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ValidFor.endDateTime	Data de término da especificação. Tipo de dados: Cadeia de caracteres
ValidFor.startDateTime	Data de início da especificação. Tipo de dados: Cadeia de caracteres
versão	Versão externa da especificação do serviço. Tipo de dados: Cadeia de caracteres Tabela: No campo external_version da tabela Especificação de serviço [sn_prd_pm_service_specification].
.	Tipo de especificação. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo cria uma especificação de serviço para um serviço de firewall.

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",
   "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'

Corpo da resposta.

{
   "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",
   "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"
}