API aberta do Catálogo de serviços

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 20 min. de leitura

    • A API aberta do Catálogo de serviços 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 Now Platform. A API aberta do Catálogo de serviços é uma implementação ServiceNow® da especificação REST da API do Catálogo de serviços do Fórum do TM. Esta implementação é baseada na especificação REST da API do Catálogo de serviços TMF633, versão 4, outubro de 2020.

    Esta API está incluída na aplicação Product Catalog Advanced, que está disponível na ServiceNow Store.

    Esta API é fornecida no namespace sn_prd_pm_adv.

    O usuário que faz a chamada 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 em aberto - GET /servicespecification

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

    Formato de URL

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

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    Nenhum
    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 o parâmetro offset para paginar a recuperação do registro.

    Padrão: 20

    Máximo: 100

    Tipo de dados: número
    deslocamento Índice inicial no qual iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Padrão: 0

    Tipo de dados: número
    state 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. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum

    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
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Intervalo de conteúdo Especifica o intervalo de conteúdo retornado em uma chamada paginada.

    Por exemplo, se deslocamento=2 e limite=3, o valor do cabeçalho Content-Range será itens 3-5.
    Tipo de conteúdo Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
    Link Contém os links a seguir para navegar pelos resultados da consulta.
    • primeiro
    • último
    • avançar
    • anterior
    X-Contagem total Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

    Códigos de status

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

    Tabela 6. Códigos de status
    Código de status Descrição
    200 Solicitação processada com êxito. 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
    description Descrição da especificação.

    Tipo de dados: cadeia de caracteres
    IDexterno External_id da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    id Inicial_versão ou external_id da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    internalId Inicial_versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    últimaAtualização 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

    "resourceSpecification": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id Inicial_versão ou external_id da especificação de recurso.

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Inicial_versão 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
    relacionamento de especificação de serviço Os relacionamentos desta especificação com outras especificações de serviço.

    Tipo de dados: matriz

    "serviceSpecificationRelationship": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "relationshipType": "String",
      "validFor": {Object},
      "version": "String"
   }
]
    serviceSpecificationRelationship.id Inicial_versão ou external_id da especificação relacionada.

    Tipo de dados: cadeia de caracteres
    relacionamentoDeEspecificaçãoDeServiço.Idinterno Inicial_versão da especificação relacionada.
    RelacionamentoDeEspecificaçãoDeServiço.Versãointerna Versão da especificação relacionada.

    Tipo de dados: cadeia de caracteres
    RelacionamentoDeEspecificaçãoDeServiço.TipoDeRelacionamento 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
    especificaçãoCaracterística Característica da especificação.

    Tipo de dados: matriz

    "specCharacteristic": [
   {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    especificaçãoCaracterística.característicaEspecificaçãoValor Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

    "characteristicValueSpecification": [
   {
      "value": "String"
   }
]
    especificaçãoCaracterística.característicaValorEspecificação.valor Valor da característica.

    Tipo de dados: cadeia de caracteres
    especificaçãoDeCaracterística.descrição Descrição da característica.

    Tipo de dados: cadeia de caracteres
    specCharacteristic.name Nome da característica.

    Tipo de dados: cadeia de caracteres
    Característicaspec.válidoPara Intervalo de datas para o qual a característica é válida.

    Tipo de dados: objeto

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    Característicaspec.válidoPara.Data/hora Data de término da característica.

    Tipo de dados: cadeia de caracteres
    Característicaspec.válidoPara.data/horainício Data de início da característica.

    Tipo de dados: cadeia de caracteres
    espec.Característica.valorTipo O 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 External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    @tipo 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 em aberto - GET /servicespecification/{specificationId}

    Recupera uma especificação de serviço.

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogmanagement/servicespecification/{specificationId}

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    ID da especificação Sys_id da especificação de serviço a ser recuperada. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    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
    state 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. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    Nenhum

    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 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Nenhum
    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 códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

    Tabela 12. Códigos de status
    Código de status Descrição
    200 Solicitação processada com êxito.
    400
    Solicitação Incorreta. Pode ser 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
    description Descrição da especificação.

    Tipo de dados: cadeia de caracteres
    IDexterno External_id da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    id Inicial_versão ou external_id da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    internalId Inicial_versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    últimaAtualização 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

    "resourceSpecification": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id Inicial_versão ou external_id da especificação de recurso.

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Inicial_versão 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
    relacionamento de especificação de serviço Os relacionamentos desta especificação com outras especificações de serviço.

    Tipo de dados: matriz

    "serviceSpecificationRelationship": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "relationshipType": "String",
      "validFor": {Object},
      "version": "String"
   }
]
    serviceSpecificationRelationship.id Inicial_versão ou external_id da especificação relacionada.

    Tipo de dados: cadeia de caracteres
    relacionamentoDeEspecificaçãoDeServiço.Idinterno Inicial_versão da especificação relacionada.
    RelacionamentoDeEspecificaçãoDeServiço.Versãointerna Versão da especificação relacionada.

    Tipo de dados: cadeia de caracteres
    RelacionamentoDeEspecificaçãoDeServiço.TipoDeRelacionamento 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
    especificaçãoCaracterística Característica da especificação.

    Tipo de dados: matriz

    "specCharacteristic": [
   {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    especificaçãoCaracterística.característicaEspecificaçãoValor Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

    "characteristicValueSpecification": [
   {
      "value": "String"
   }
]
    especificaçãoCaracterística.característicaValorEspecificação.valor Valor da característica.

    Tipo de dados: cadeia de caracteres
    especificaçãoDeCaracterística.descrição Descrição da característica.

    Tipo de dados: cadeia de caracteres
    specCharacteristic.name Nome da característica.

    Tipo de dados: cadeia de caracteres
    Característicaspec.válidoPara Intervalo de datas para o qual a característica é válida.

    Tipo de dados: objeto

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    Característicaspec.válidoPara.Data/hora Data de término da característica.

    Tipo de dados: cadeia de caracteres
    Característicaspec.válidoPara.data/horainício Data de início da característica.

    Tipo de dados: cadeia de caracteres
    espec.Característica.valorTipo O 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 External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    @tipo 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 em aberto - POST /servicespecification

    Cria uma especificação de serviço.

    Formato de URL

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

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    Nenhum
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum
    Tabela 15. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    description Obrigatório. Descrição da especificação.

    Tipo de dados: cadeia de caracteres
    IDexterno External_id da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Se externalId e id forem fornecidos, eles deverão se referir à mesma especificação.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    id Inicial_versão ou external_id da especificação de serviço. Se id não for fornecido, este endpoint criará uma nova especificação com versão = 1. Se id for fornecido, este endpoint criará uma nova versão da especificação fornecida.

    Se externalId e id forem fornecidos, eles deverão se referir à mesma especificação.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    últimaAtualização Data em que a especificação foi atualizada pela última vez.

    Tipo de dados: cadeia de caracteres

    Padrão: 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

    "resourceSpecification": [
   {
      "id": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id Obrigatório. Inicial_versão ou external_id da especificação de recurso.

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalVersion External_version da especificação do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    resourceSpecification.name Nome da especificação do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    resourceSpecification.version Versão da especificação do recurso.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    relacionamento de especificação de serviço Os relacionamentos desta especificação com outras especificações de serviço.

    Tipo de dados: matriz

    "serviceSpecificationRelationship": [
   {
      "id": "String",
      "internalVersion": "String",
      "relationshipType": "String",
      "validFor": {Object},
      "version": "String"
   }
]
    serviceSpecificationRelationship.id Obrigatório se estiver usando o parâmetro serviceSpecificationRelationship. Inicial_versão ou external_id da especificação relacionada.

    Tipo de dados: cadeia de caracteres
    RelacionamentoDeEspecificaçãoDeServiço.Versãointerna Versão da especificação relacionada.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    RelacionamentoDeEspecificaçãoDeServiço.TipoDeRelacionamento Obrigatório se estiver usando o parâmetro serviceSpecificationRelationship. Tipo de relacionamento.
    Valores válidos:
    • composto_de
    • pacotes

    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

    Padrão: cadeia de caracteres em branco
    serviceSpecificationRelationship.validFor.startDateTime Data de início do relacionamento.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    ServiceSpecificationRelationship.version External_version da especificação relacionada.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    especificaçãoCaracterística Característica da especificação.

    Tipo de dados: matriz

    "specCharacteristic": [
   {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    especificaçãoCaracterística.característicaEspecificaçãoValor Obrigatório. Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

    "characteristicValueSpecification": [
   {
      "value": "String"
   }
]
    especificaçãoCaracterística.característicaValorEspecificação.valor Obrigatório. Valor da característica.

    Tipo de dados: cadeia de caracteres
    especificaçãoDeCaracterística.descrição Descrição da característica.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    specCharacteristic.name Obrigatório. Nome da característica.

    Tipo de dados: cadeia de caracteres
    Característicaspec.válidoPara Intervalo de datas para o qual a característica é válida.

    Tipo de dados: objeto

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    Característicaspec.válidoPara.Data/hora Data de término da característica.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    Característicaspec.válidoPara.data/horainício Data de início da característica.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    espec.Característica.valorTipo Obrigatório. O 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

    Padrão: cadeia de caracteres em branco
    validFor.startDateTime Data de início da especificação.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    versão External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    A versão deve ser exclusiva para a cadeia de versões fornecida.

    Tipo de dados: cadeia de caracteres

    Padrão: cadeia de caracteres em branco
    @tipo Obrigatório. Tipo de especificação.
    Valores válidos:
    • CustomerFacingServiceSpecification
    • ResourceFacingServiceSpecification

    Tipo de dados: cadeia de caracteres

    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 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 códigos de status a seguir se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP da REST API.

    Tabela 18. Códigos de status
    Código de status Descrição
    201 Solicitação processada com sucesso.
    400 Solicitação Incorreta. Pode ser 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
    description Descrição da especificação.

    Tipo de dados: cadeia de caracteres
    IDexterno External_id da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    id Inicial_versão ou external_id da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    internalId Inicial_versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    internalVersion Versão da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    últimaAtualização 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

    "resourceSpecification": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "name": "String",
      "version": "String"
   }
]
    resourceSpecification.id Inicial_versão ou external_id da especificação de recurso.

    Tipo de dados: cadeia de caracteres
    resourceSpecification.internalId Inicial_versão 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
    relacionamento de especificação de serviço Os relacionamentos desta especificação com outras especificações de serviço.

    Tipo de dados: matriz

    "serviceSpecificationRelationship": [
   {
      "id": "String",
      "internalId": "String",
      "internalVersion": "String",
      "relationshipType": "String",
      "validFor": {Object},
      "version": "String"
   }
]
    serviceSpecificationRelationship.id Inicial_versão ou external_id da especificação relacionada.

    Tipo de dados: cadeia de caracteres
    relacionamentoDeEspecificaçãoDeServiço.Idinterno Inicial_versão da especificação relacionada.
    RelacionamentoDeEspecificaçãoDeServiço.Versãointerna Versão da especificação relacionada.

    Tipo de dados: cadeia de caracteres
    RelacionamentoDeEspecificaçãoDeServiço.TipoDeRelacionamento 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
    especificaçãoCaracterística Característica da especificação.

    Tipo de dados: matriz

    "specCharacteristic": [
   {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
   }
]
    especificaçãoCaracterística.característicaEspecificaçãoValor Matriz que contém os valores possíveis da característica.

    Tipo de dados: matriz

    "characteristicValueSpecification": [
   {
      "value": "String"
   }
]
    especificaçãoCaracterística.característicaValorEspecificação.valor Valor da característica.

    Tipo de dados: cadeia de caracteres
    especificaçãoDeCaracterística.descrição Descrição da característica.

    Tipo de dados: cadeia de caracteres
    specCharacteristic.name Nome da característica.

    Tipo de dados: cadeia de caracteres
    Característicaspec.válidoPara Intervalo de datas para o qual a característica é válida.

    Tipo de dados: objeto

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    Característicaspec.válidoPara.Data/hora Data de término da característica.

    Tipo de dados: cadeia de caracteres
    Característicaspec.válidoPara.data/horainício Data de início da característica.

    Tipo de dados: cadeia de caracteres
    espec.Característica.valorTipo O 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 External_version da especificação de serviço. Localizado na tabela Especificação de serviço [sn_prd_pm_service_specification].

    Tipo de dados: cadeia de caracteres
    @tipo 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"
}