Abrir API do Catálogo de serviços

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 42 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 em Especificação REST da API do catálogo de serviços DO TMF633 Versão 4 , Outubro de 2020.

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

    Os endpoints desta API são fornecidos no api sn_tmf namespace em Catálogo de produtos aberto Nome da API:

    O usuário solicitante 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]

    Abrir catálogo de serviços - EXCLUA /api/sn_tmf_api/catalogmanagement/serviceCategory/

    Exclui o registro de categoria de serviço especificado na tabela Categoria de especificação [sn_prd_pm_specification_category].

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogagement/serviceCategory/

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    id Sys_id da categoria de serviço a ser excluída.

    Tabela: Categoria de serviço [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Solicitar parâmetros do corpo (XML ou 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 da REST API compatíveis .

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da solicitação. Compatível somente com aplicação/json.
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    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 REST API códigos de resposta HTTP .

    Tabela 6. Códigos de status
    Código de status Descrição
    204 Não há conteúdo.
    400 Solicitação incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    Nenhum(a)

    Solicitação de curl

    O exemplo a seguir exclui uma categoria de serviço com ID, a1b23456c7de8a90f0123456gh789ij. Retorna um código de status com mensagens.

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

    Abrir catálogo de serviços - OBTER /api/sn_tmf_api/catalogmanagement/serviceCategory

    Recupera uma lista de todos os registros de categoria de serviço na tabela Categoria de serviço [sn_prd_pm_specification_category].

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogagement/serviceCategory

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados.
    Campos válidos:
    • href
    • id
    • nome

    Tipo de dados: Cadeia de caracteres

    Padrão: Retorna todos os campos
    id Filtre categorias de serviço por sys_id(s) específico(s).

    Tabela: Categoria de serviço [service_category]

    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 iniciar a recuperação de registros. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Use este valor para paginar a recuperação de registro. Não use um valor numérico negativo.

    Tipo de dados: Número

    Padrão: 0
    Tabela 9. Solicitar parâmetros do corpo (XML ou 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 da REST API compatíveis .

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Accept:application/json
    Tabela 11. 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 igual a 2 e. limite: 3 , O valor do cabeçalho Intervalo de conteúdo é Itens 3-5 .
    Tipo de conteúdo Formato de dados do corpo da resposta. Compatível somente com aplicação/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 REST API códigos de resposta HTTP .

    Tabela 12. Códigos de status
    Código de 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 ou XML)

    Nome Descrição
    ExternalIdentifier Informações de identificação de um sistema externo envolvido no gerenciamento de categorias.

    Tipo de dados: Matriz de objetos

    "externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]
    externalIdentifier.id Identificador exclusivo da categoria de serviço. Este valor é determinado por um sistema externo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria de serviço [sn_prd_pm_specification_category], campo external_id
    Identifier.owner O sistema proprietário do ID externo fornecido.

    Tipo de dados: Cadeia de caracteres
    href Hiperlink para acessar a categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    id Sys_id da categoria de serviço.

    Tabela: Categoria de serviço [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    IsRoot Sinalizador que indica se a categoria é uma raiz de categorias.
    Valores válidos:
    • Verdadeiro: A categoria é uma raiz de categorias.
    • Falso: A categoria não é uma raiz de categorias.

    Tipo de dados: Booliano
    Categoria de modelo Lista de categorias de modelo associadas à categoria de serviço.

    Tipo de dados: Matriz de objetos

    "modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]
    modelCategory.id Sys_id da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    modelCategory.name Nome da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    nome Nome da categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    Serviço Candidato Lista de referências de candidatos a serviço associadas a esta categoria.

    Tipo de dados: Matriz de objetos

    "serviceCandidate": [
 {
  "id": "String",
  "href": "String",
  "name": "String",
  "@referredType": "String",
  "version": "String" 
 }
]
    ServiceCandidate. Em referredType O valor é sempre ServiceCategory .

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.href Hiperlink para acessar a especificação de serviço.

    Tipo de dados: Cadeia de caracteres
    serviceCandidate.id Sys_id da especificação de serviço.

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.version Versão do candidato ao serviço.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir chama a operação OBTER para retornar uma lista de todos os registros de categoria de serviço na tabela Categoria de serviço [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'
``

    Corpo da resposta.

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

    Abrir catálogo de serviços - OBTER /api/sn_tmf_api/catalogmanagement/serviceCategory/

    Recupera um registro de categoria de serviço específico na tabela Categoria de especificação [sn_prd_pm_specification_category].

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogagement/serviceCategory

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    id Sys_id da categoria de serviço a ser recuperada.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    Tabela 14. Parâmetros de consulta
    Nome Descrição
    campos Lista de campos a serem retornados na resposta. Campos inválidos são ignorados.
    Campos válidos:
    • href
    • id
    • nome

    Tipo de dados: Cadeia de caracteres

    Padrão: Retorna todos os campos
    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 iniciar a recuperação de registros. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Use este valor para paginar a recuperação de registro. Não use um valor numérico negativo.

    Tipo de dados: Número

    Padrão: 0
    Tabela 15. Solicitar parâmetros do corpo (XML ou 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 da REST API compatíveis .

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Accept:application/json
    Tabela 17. 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 igual a 2 e. limite: 3 , O valor do cabeçalho Intervalo de conteúdo é Itens 3-5 .
    Tipo de conteúdo Formato de dados do corpo da resposta. Compatível somente com aplicação/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 REST API códigos de resposta HTTP .

    Tabela 18. Códigos de status
    Código de 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 ou XML)

    Nome Descrição
    ExternalIdentifier Informações de identificação de um sistema externo envolvido no gerenciamento de categorias.

    Tipo de dados: Matriz de objetos

    "externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]
    externalIdentifier.id Identificador exclusivo da categoria de serviço. Este valor é determinado por um sistema externo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria de especificação [sn_prd_pm_specification_category], Campo: External_id
    Identifier.owner O sistema proprietário deste ID.

    Tipo de dados: Cadeia de caracteres
    href Hiperlink para acessar a categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    id Sys_id da categoria de serviço.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    IsRoot Sinalizador que indica se a categoria é uma raiz de categorias.
    Valores válidos:
    • Verdadeiro: A categoria é uma raiz de categorias.
    • Falso: A categoria não é uma raiz de categorias.

    Tipo de dados: Booliano
    Categoria de modelo Lista de categorias de modelo associadas à categoria de serviço.

    Tipo de dados: Matriz de objetos

    "modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]
    modelCategory.id Sys_id da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    modelCategory.name Nome da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    nome Nome da categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    Serviço Candidato Lista de candidatos a serviço associados a esta categoria.

    Tipo de dados: Matriz de objetos

    "serviceCandidate": [
 {
  "id": "String",
  "href": "String",
  "name": "String",
  "@referredType": "String",
  "version": "String" 
 }
]
    ServiceCandidate. Em referredType Tipo referenciado do candidato ao serviço. O valor é sempre ServiceCategory .

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.href Hiperlink para acessar a especificação de serviço.

    Tipo de dados: Cadeia de caracteres
    serviceCandidate.id Sys_id da especificação de serviço.

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.version Versão do candidato ao serviço.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir chama a operação GET para retornar um registro de categoria de serviço específico de acordo com um determinado ID, a2a68216d9ce2a90f87718429ae503dd.

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

    Corpo da resposta.

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

    Abrir catálogo de serviços - OBTER /especificação de serviço

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

    Formato de URL

    URL padrão: /api/sn_prd_pm_adv/catalogagement/servicspecification

    Parâmetros de solicitação compatíveis

    Tabela 19. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 20. 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 iniciar a recuperação de 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 21. 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 da REST API compatíveis .

    Tabela 22. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Nenhum(a)
    Tabela 23. 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 igual a 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 REST API códigos de resposta HTTP .

    Tabela 24. Códigos de status
    Código de 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
    . Tipo de especificação.

    Tipo de dados: Cadeia de caracteres
    descrição Descrição da especificação.

    Tipo de dados: Cadeia de caracteres
    externalId ID externo da especificação de 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].
    Sistema externo Sistema externo da especificação de serviço, anexado com TMF633 .

    Por exemplo, se o sistema externo for ABC, insira o valor em externalSystemcomo ABC-TMF633 .

    Tipo de dados: Cadeia de caracteres
    Sistema externo Plataforma de terceiros ou não nativa que interage com o catálogo de serviços. O valor é sempre anexado com TMF633 . Por exemplo, se o sistema externo for ABC em seguida, o valor na origem externa deve ser ABC-TMF633 .

    Tipo de dados: Cadeia de caracteres
    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].
    Versão interna 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 recurso 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 O initial_version ou external_id da especificação do recurso.

    Tipo de dados: Cadeia de caracteres
    resourceSpecification.internalId O initial_version da especificação do recurso.

    Tipo de dados: Cadeia de caracteres
    resourceSpecification.internalVersion O 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 As relações 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 O initial_version ou external_id da especificação relacionada.

    Tipo de dados: Cadeia de caracteres
    serviceSpecificationRelationship.internalId O 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.Relationship Type 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 O external_version da especificação relacionada.

    Tipo de dados: Cadeia de caracteres
    Característica específica Característica da 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
    Característica especpe.validFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    Caracteristic.validFor.endDateTime Data de término da característica.

    Tipo de dados: Cadeia de caracteres
    Caracteristic.validFor.startDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres
    Característica.ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser uma característica simples ou complexa.
    Valores possíveis:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Texto de linha única
    • Obect
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha

    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].

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

    Abrir catálogo de serviços - OBTER /servicspecification/

    Recupera uma especificação de serviço.

    Formato de URL

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

    Parâmetros de solicitação compatíveis

    Tabela 25. 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 26. 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 27. 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 da REST API compatíveis .

    Tabela 28. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Nenhum(a)
    Tabela 29. 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 REST API códigos de resposta HTTP .

    Tabela 30. Códigos de status
    Código de 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
    . Tipo de especificação.

    Tipo de dados: Cadeia de caracteres
    descrição Descrição da especificação.

    Tipo de dados: Cadeia de caracteres
    externalId ID externo da especificação de 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].
    Sistema externo Sistema externo da especificação de serviço, anexado com TMF633 .

    Por exemplo, se o sistema externo for ABC, insira o valor em externalSystemcomo ABC-TMF633 .

    Tipo de dados: Cadeia de caracteres
    Sistema externo Plataforma de terceiros ou não nativa que interage com o catálogo de serviços. O valor é sempre anexado com TMF633 . Por exemplo, se o sistema externo for ABC em seguida, o valor na origem externa deve ser ABC-TMF633 .

    Tipo de dados: Cadeia de caracteres
    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].
    Versão interna 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 recurso 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 O initial_version ou external_id da especificação do recurso.

    Tipo de dados: Cadeia de caracteres
    resourceSpecification.internalId O initial_version da especificação do recurso.

    Tipo de dados: Cadeia de caracteres
    resourceSpecification.internalVersion O 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 As relações 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 O initial_version ou external_id da especificação relacionada.

    Tipo de dados: Cadeia de caracteres
    serviceSpecificationRelationship.internalId O 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.Relationship Type 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 O external_version da especificação relacionada.

    Tipo de dados: Cadeia de caracteres
    Característica específica Característica da 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
    Característica especpe.validFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    Caracteristic.validFor.endDateTime Data de término da característica.

    Tipo de dados: Cadeia de caracteres
    Caracteristic.validFor.startDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres
    Característica.ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser uma característica simples ou complexa.
    Valores possíveis:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Texto de linha única
    • Obect
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha

    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].

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

    Categoria de serviço aberta - PATCH /api/sn_tmf_api/catalogmanagement/serviceCategory/

    Atualiza um registro especificado na tabela Categoria de especificação [sn_prd_pm_specification_category].

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogagement/serviceCategory/

    Parâmetros de solicitação compatíveis

    Tabela 31. Parâmetros de caminho
    Nome Descrição
    id Sys_id da tabela de categoria de serviço.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    Tabela 32. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 33. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    ExternalIdentifier Informações de identificação de um sistema externo envolvido no gerenciamento de categorias.

    Tipo de dados: Matriz de objetos

    "externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]
    externalIdentifier.id Identificador exclusivo da categoria de serviço. Este valor é determinado por um sistema externo.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category], Campo: External_id

    Tipo de dados: Cadeia de caracteres
    Identifier.owner O sistema proprietário deste ID.

    Tipo de dados: Cadeia de caracteres
    href Hiperlink para acessar a categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    id Sys_id da categoria de serviço.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    IsRoot Sinalizador que indica se a categoria é uma raiz de categorias.
    Valores válidos:
    • Verdadeiro: A categoria é uma raiz de categorias.
    • Falso: A categoria não é uma raiz de categorias.

    Tipo de dados: Booliano
    Categoria de modelo Lista de categorias de modelo associadas à categoria de serviço.

    Tipo de dados: Matriz de objetos

    "modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]
    modelCategory.id Sys_id da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    modelCategory.name Nome da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    nome Nome da categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    Serviço Candidato Lista de candidatos a serviço associados a esta categoria.

    Tipo de dados: Matriz de objetos

    "serviceCandidate": [
 {
  "@referredType": "String",
  "href": "String",
  "id": "String",
  "name": "String",
  "version": "String" 
 }
]
    ServiceCandidate. Em referredType O valor é sempre ServiceCategory .

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.href Hiperlink para acessar a especificação de serviço.

    Tipo de dados: Cadeia de caracteres
    serviceCandidate.id Sys_id da especificação de serviço.

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.version Versão do candidato ao serviço.

    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 da REST API compatíveis .

    Tabela 34. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 35. Cabeçalhos de resposta
    Cabeçalho 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 da REST API compatíveis .

    Tabela 36. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da solicitação. Compatível somente com aplicação/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Compatível somente com aplicação/json.
    Tabela 37. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Compatível somente com aplicação/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 REST API códigos de resposta HTTP .

    Tabela 38. Códigos de status
    Código de status Descrição
    201 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta.
    Um tipo de solicitação inválido ou uma solicitação malformada foi detectada por um ou mais dos seguintes motivos:
    • Carga vazia.
    • Carga inválida.
    • Campo obrigatório ausente.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    ExternalIdentifier Informações de identificação de um sistema externo envolvido no gerenciamento de categorias.

    Tipo de dados: Matriz de objetos

    "externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]
    Identifier.id Identificador exclusivo da categoria de serviço. Este valor é determinado por um sistema externo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria de especificação [sn_prd_pm_specification_category], Campo: External_id
    Identifier.owner O sistema proprietário deste ID.

    Tipo de dados: Cadeia de caracteres
    href Hiperlink para acessar a categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    id Sys_id da categoria de serviço.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    IsRoot Sinalizador que indica se a categoria é uma raiz de categorias.
    Valores válidos:
    • Verdadeiro: A categoria é uma raiz de categorias.
    • Falso: A categoria não é uma raiz de categorias.

    Tipo de dados: Booliano
    Categoria de modelo Lista de categorias de modelo associadas à categoria de serviço.

    Tipo de dados: Matriz de objetos

    "modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]
    ModelCategory.id Sys_id da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    modelCategory.name Nome da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    nome Nome da categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    Serviço Candidato Lista de candidatos a serviço associados a esta categoria.

    Tipo de dados: Matriz de objetos

    "serviceCandidate": [
 {
  "@referredType": "String",
  "href": "String",
  "id": "String",
  "name": "String",
  "version": "String" 
 }
]
    ServiceCandidate. Em referredType O valor é sempre ServiceCategory .

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.href Hiperlink para acessar a especificação de serviço.

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.id Sys_id da especificação de serviço.

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.version Versão do candidato ao serviço.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir atualiza o nome, a versão, o candidato ao serviço, a categoria do modelo e as informações do identificador externo da categoria de serviço.

    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

    Corpo da resposta.

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

    Abrir catálogo de serviços - POST /api/sn_tmf_api/catalogmanagement/serviceCategory

    Cria um novo registro de categoria de serviço na tabela Categoria de especificação [sn_prd_pm_specification_category].

    Formato de URL

    URL padrão: /api/sn_tmf_api/catalogagement/serviceCategory

    Parâmetros de solicitação compatíveis

    Tabela 39. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 40. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 41. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    ExternalIdentifier Informações de identificação de um sistema externo envolvido no gerenciamento de categorias.

    Tipo de dados: Matriz de objetos

    "externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]
    externalIdentifier.id Identificador exclusivo da categoria de serviço. Este valor é determinado por um sistema externo.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category], Campo: External_id

    Tipo de dados: Cadeia de caracteres
    Identifier.owner O sistema proprietário deste ID.

    Tipo de dados: Cadeia de caracteres
    href Hiperlink para acessar a categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    id Sys_id da categoria de serviço.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    IsRoot Sinalizador que indica se a categoria é uma raiz de categorias.
    Valores válidos:
    • Verdadeiro: A categoria é uma raiz de categorias.
    • Falso: A categoria não é uma raiz de categorias.

    Tipo de dados: Booliano
    Categoria de modelo Lista de categorias de modelo associadas à categoria de serviço.

    Tipo de dados: Matriz de objetos

    "modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]
    modelCategory.id Sys_id da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    modelCategory.name Nome da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    nome Nome da categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    Serviço Candidato Lista de candidatos a serviço associados a esta categoria.

    Tipo de dados: Matriz de objetos

    "serviceCandidate": [
 {
  "id": "String",
  "href": "String",
  "name": "String",
  "@referredType": "String",
  "version": "String" 
 }
]
    ServiceCandidate. Em referredType O valor é sempre ServiceCategory .

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.href Hiperlink para acessar a especificação de serviço.

    Tipo de dados: Cadeia de caracteres
    serviceCandidate.id Sys_id da especificação de serviço.

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.version Versão do candidato ao serviço.

    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 da REST API compatíveis .

    Tabela 42. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da solicitação. Compatível somente com aplicação/json.
    Tipo de conteúdo Formato de dados do corpo da solicitação. Compatível somente com aplicação/json.
    Tabela 43. Cabeçalhos de resposta
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da resposta. Compatível somente com aplicação/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 REST API códigos de resposta HTTP .

    Tabela 44. Códigos de status
    Código de status Descrição
    201 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta.
    Um tipo de solicitação inválido ou uma solicitação malformada foi detectada por um ou mais dos seguintes motivos:
    • Carga vazia.
    • Carga inválida.
    • Campo obrigatório ausente.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    ExternalIdentifier Informações de identificação de um sistema externo envolvido no gerenciamento de categorias.

    Tipo de dados: Matriz de objetos

    "externalIdentifier": [
 {
  "id": "String",
  "owner": "String"
 }
]
    Identifier.id Identificador exclusivo da categoria de serviço. Este valor é determinado por um sistema externo.

    Tipo de dados: Cadeia de caracteres

    Tabela: Categoria de especificação [sn_prd_pm_specification_category], Campo: External_id
    Identifier.owner O sistema proprietário deste ID.

    Tipo de dados: Cadeia de caracteres
    href Hiperlink para acessar a categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    id Sys_id da categoria de serviço.

    Tabela: Categoria de especificação [sn_prd_pm_specification_category]

    Tipo de dados: Cadeia de caracteres
    IsRoot Sinalizador que indica se a categoria é uma raiz de categorias.
    Valores válidos:
    • Verdadeiro: A categoria é uma raiz de categorias.
    • Falso: A categoria não é uma raiz de categorias.

    Tipo de dados: Booliano
    Categoria de modelo Lista de categorias de modelo associadas à categoria de serviço.

    Tipo de dados: Matriz de objetos

    "modelCategory": [
 {
  "id": "String",
  "name": "String"
 }
]
    ModelCategory.id Sys_id da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    modelCategory.name Nome da categoria do modelo.

    Tabela: Categoria do modelo [cmdb_model_category]

    Tipo de dados: Cadeia de caracteres
    nome Nome da categoria de serviço.

    Tipo de dados: Cadeia de caracteres
    Serviço Candidato Lista de candidatos a serviço associados a esta categoria.

    Tipo de dados: Matriz de objetos

    "serviceCandidate": [
 {
  "id": "String",
  "href": "String",
  "name": "String",
  "@referredType": "String",
  "version": "String" 
 }
]
    ServiceCandidate. Em referredType O valor é sempre ServiceCategory .

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.href Hiperlink para acessar a especificação de serviço.

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.id Sys_id da especificação de serviço.

    Tabela: Especificação de serviço [sn_prd_pm_service_specification]

    Tipo de dados: Cadeia de caracteres
    ServiceCandidate.version Versão do candidato ao serviço.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir chama POST para criar um novo registro de categoria de serviço de acordo com os detalhes fornecidos no corpo da solicitação.

    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
  }'

    Corpo da resposta.

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

    Abrir catálogo de serviços - 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/catalogagement/servicspecification

    Parâmetros de solicitação compatíveis

    Tabela 45. Parâmetros de caminho
    Nome Descrição
    Nenhum(a)
    Tabela 46. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 47. Solicitar parâmetros do corpo (JSON)
    Nome Descrição
    descrição Necessário. Descrição da especificação.

    Tipo de dados: Cadeia de caracteres
    externalId ID externo da especificação de serviço.

    Se ambos externalIde. idsão fornecidos, 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]
    Sistema externo Plataforma de terceiros ou não nativa que interage com o catálogo de serviços. O valor é sempre anexado com TMF633 .

    Por exemplo, se o sistema externo for ABC em seguida, o valor na origem externa deve ser ABC-TMF633 .

    Tipo de dados: Cadeia de caracteres
    id O initial_version ou external_id da especificação de serviço. Se idnão foi fornecido, este endpoint cria uma nova especificação com a versão 1. Se idfor fornecido, este endpoint cria uma nova versão da especificação fornecida.

    Se ambos externalIde. idsão fornecidos, eles devem se referir à mesma especificação.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco
    Versão interna 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 Necessário. Nome da especificação.

    Tipo de dados: Cadeia de caracteres
    ResourceSpecification Necessário. Especificações de recurso para esta especificação de serviço.

    Tipo de dados: Matriz de objetos

    "resourceSpecification": [
  {
    "id": "String",
    "internalVersion": "String",
    "name": "String",
    "version": "String"
  }
]
    ResourceSpecification.id Necessário. O initial_version ou external_id da especificação do recurso.

    Tipo de dados: Cadeia de caracteres
    resourceSpecification.internalVersion O 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 das relações 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.Relationship Type 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 O external_version da especificação relacionada.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco
    Característica específica Característica da especificação.

    Tipo de dados: Matriz de objetos

    "specCharacteristic": [
  {
    "characteristicValueSpecification": [Array],
    "description": "String",
    "name": "String",
    "validFor": {Object},
    "valueType": "String"
  }
]
    specCharacteristic.characteristicValueSpecification Necessário. Valores possíveis da característica.

    Tipo de dados: Matriz de objetos

    "characteristicValueSpecification": [
  {
    "value": "String"
  }
]
    specCharacteristic.characteristicValueSpecification.value Necessá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 Necessário. Nome da característica.

    Tipo de dados: Cadeia de caracteres
    Característica especpe.validFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    Caracteristic.validFor.endDateTime Data de término da característica.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco
    Caracteristic.validFor.startDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres

    Cadeia de caracteres em branco
    Característica.ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser uma característica simples ou complexa.
    Valores possíveis:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Texto de linha única
    • Obect
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha

    Tipo de dados: Cadeia de caracteres
    ValidFor Necessá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].
    . Necessário. Tipo de especificação.
    Valores válidos:
    • EspecificaçãoServiçoAtenderCliente
    • 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 da REST API compatíveis .

    Tabela 48. 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 49. 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 REST API códigos de resposta HTTP .

    Tabela 50. Códigos de status
    Código de 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
    . Tipo de especificação.

    Tipo de dados: Cadeia de caracteres
    descrição Descrição da especificação.

    Tipo de dados: Cadeia de caracteres
    externalId ID externo da especificação de 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].
    Sistema externo Sistema externo da especificação de serviço, anexado com TMF633 .

    Por exemplo, se o sistema externo for ABC, insira o valor em externalSystemcomo ABC-TMF633 .

    Tipo de dados: Cadeia de caracteres
    Sistema externo Plataforma de terceiros ou não nativa que interage com o catálogo de serviços. O valor é sempre anexado com TMF633 . Por exemplo, se o sistema externo for ABC em seguida, o valor na origem externa deve ser ABC-TMF633 .

    Tipo de dados: Cadeia de caracteres
    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].
    Versão interna 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 recurso 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 O initial_version ou external_id da especificação do recurso.

    Tipo de dados: Cadeia de caracteres
    resourceSpecification.internalId O initial_version da especificação do recurso.

    Tipo de dados: Cadeia de caracteres
    resourceSpecification.internalVersion O 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 As relações 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 O initial_version ou external_id da especificação relacionada.

    Tipo de dados: Cadeia de caracteres
    serviceSpecificationRelationship.internalId O 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.Relationship Type 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 O external_version da especificação relacionada.

    Tipo de dados: Cadeia de caracteres
    Característica específica Característica da 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
    Característica especpe.validFor Intervalo de datas para o qual a característica é válida.

    Tipo de dados: Objeto

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    Caracteristic.validFor.endDateTime Data de término da característica.

    Tipo de dados: Cadeia de caracteres
    Caracteristic.validFor.startDateTime Data de início da característica.

    Tipo de dados: Cadeia de caracteres
    Característica.ValorType Tipo de valor da característica, como opção ou e-mail. Pode ser uma característica simples ou complexa.
    Valores possíveis:
    • Data, Endereço
    • Inteiro, Data/Hora
    • Array.Integer
    • Teste de linha única
    • Texto de linha única
    • Obect
    • Array.Date
    • Array.Decimal
    • Sim/Não
    • Objeto
    • Array.Datetime
    • Caixa de seleção
    • E-mail
    • Escolha

    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].

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

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