Veja campos adicionais elegíveis para dependências

Detalhes da petição

URL base: {host}/ASMSAPI/
Uri: /api/v9/additionalsfields/dependents/list/{itemType}/{modelId}
Tipo: GET
Títulos obrigatórios:
tipo de conteúdo: application/json
Autorização X: Portador {token}

Descrição do URL

{host}: Ele representa o domínio do ambiente no qual a API está localizada.
ASMSAPI/: Prefixo de API fixo.
URI: Ponto de extremidade específico para a solicitação.
{itemType}: Tipo de caso no qual os campos adicionais são consultados. Valores aceitos: Incidents, ServiceCall, Change, Problem, Release.
{modelId}: Identificador numérico do modelo para o qual os campos adicionais devem ser consultados.

⚐ URL DE EXEMPLO:

https://{host}/ASMSAPI/api/v9/additionalsfields/dependents/list/ServiceCall/28

Parâmetros da URL

Nome	Tipo de dado	Obrigatório	Descrição
tipo de item	Texto	Sim	Tipo de caso. Valores aceitos: Incidentes, ServiceCall, Mudança, Problema, Liberação.
ID do modelo	Número	Sim	Identificador do modelo para o qual os campos adicionais são consultados.

Parâmetros de consulta

Nome	Tipo de dado	Obrigatório	Descrição
onlySourceFields	Booleano	Não	Indica se apenas os campos que podem atuar como campo pai em uma dependência (Lista, CatálogoLista, Caixa de Seleção) são retornados. Se omitido, o valor padrão é `true`. Se for enviada `false`, retorna todos os campos adicionais do modelo, incluindo ShortText, Numeric, Decimal, Currency e outros, permitindo que você identifique os campos disponíveis como campos filhos.

Pedido de Exemplo

Devolva apenas campos elegíveis como pai (onlySourceFields=true):

GET https://{host}/ASMSAPI/api/v9/additionalsfields/dependents/list/ServiceCall/28

Devolva todos os campos do modelo (onlySourceFields=false):

GET https://{host}/ASMSAPI/api/v9/additionalsfields/dependents/list/ServiceCall/28?onlySourceFields=false

Responder

{
    "content": [
        {
            "catalogId": null,
            "fieldId": 543,
            "fieldType": "List",
            "hasDependencies": true,
            "name": "País"
        },
        {
            "catalogId": null,
            "fieldId": 544,
            "fieldType": "List",
            "hasDependencies": false,
            "name": "Ciudad"
        },
        {
            "catalogId": 22,
            "fieldId": 545,
            "fieldType": "CatalogList",
            "hasDependencies": false,
            "name": "Sucursal"
        },
        {
            "catalogId": null,
            "fieldId": 552,
            "fieldType": "CheckBox",
            "hasDependencies": true,
            "name": "¿Es sede principal?"
        },
        {
            "catalogId": null,
            "fieldId": 546,
            "fieldType": "ShortText",
            "hasDependencies": false,
            "name": "Código Postal"
        }
    ],
    "totalItems": 5
}

Parâmetros de resposta

Nome	Tipo de dado	Descrição
totalItems	Número	Campos adicionais totais encontrados para o modelo consultado.
conteúdo	Lista	Lista de campos adicionais do modelo.
catalogId	Número	Identificador do catálogo associado ao campo. Ele só vem com valor para campos do tipo CatalogList. Para os campos List e CheckBox, o valor é `null`.
ID do campo	Número	Identificador único do campo adicional. Esse valor é usado como `sourceFieldId` ou `targetFieldId` nos endpoints LOAD, RESOLVE e DELETE.
tipo de campo	Texto	Tipo de dado adicional de campo. Valores possíveis: `List`, `CatalogList`, `CheckBox`, `ShortText`, `Numeric`, `Decimal`, `Currency`, `Date`, entre outros.
hasDependencies	Booleano	Indica se o campo possui dependências configuradas como campo pai.
Nome	Texto	Nome do campo adicional conforme configurado no ASMS Administrator.

Consultar valores de campo pai

Uma vez que o fieldId dos campos elegíveis, é necessário consultar os valores disponíveis de cada campo pai para obter o triggerValueId exigido nos endpoints LOAD, RESOLVE e DELETE.

Para campos FieldType: “List”:

GET https://{host}/ASMSAPI/api/v9/additionalsfields/{fieldId}/type/3/values?dataType=0

Para campos CatalogList (campoTipo: “CatalogList”):

GET https://{host}/ASMSAPI/api/v9/additionalsfields/{fieldId}/type/11/values?catalogId={catalogId}

⚐ NOTA: Para Campos de Tipo Caixa de Seleção (Falso/Verdadeiro) Não é necessário. O triggerValueId para esse tipo de campo é sempre 1 (verdade). Não existe um triggerValueId para o valor falso porque dependências nos campos CheckBox são configuradas apenas para o valor verdadeiro.

Exemplo de resposta para um campo Lista:

{
    "content": [
        {
            "catalogId": 0,
            "description": null,
            "fieldId": 543,
            "hasChild": false,
            "id": 494,
            "key": null,
            "name": "Colombia",
            "order": 0,
            "parentId": null,
            "restrictLevel": false,
            "status": 0
        },
        {
            "catalogId": 0,
            "description": null,
            "fieldId": 543,
            "hasChild": false,
            "id": 495,
            "key": null,
            "name": "Argentina",
            "order": 0,
            "parentId": null,
            "restrictLevel": false,
            "status": 0
        }
    ],
    "totalItems": 2
}

Exemplo de resposta para um campo CatalogList:

{
    "content": [
        {
            "catalogId": 22,
            "description": null,
            "fieldId": null,
            "hasChild": false,
            "id": 81,
            "key": "Sede Norte(SN-001)",
            "name": "Sede Norte(SN-001)",
            "order": 1,
            "parentId": null,
            "restrictLevel": null,
            "status": 1
        },
        {
            "catalogId": 22,
            "description": null,
            "fieldId": null,
            "hasChild": false,
            "id": 82,
            "key": "Sede Sur(SS-002)",
            "name": "Sede Sur(SS-002)",
            "order": 2,
            "parentId": null,
            "restrictLevel": null,
            "status": 1
        }
    ],
    "totalItems": 2
}

Parâmetros de resposta

Nome	Tipo de dado	Descrição
Id	Número	Identificador do valor. Esse valor é usado como `triggerValueId` nos endpoints LOAD, RESOLVE e DELETE.
Nome	Texto	Nome do valor conforme configurado no ASMS Administrator.
Chave	Texto	Chave para o valor. Ele só vem com valor para campos do tipo CatalogList. Para campos de tipo Lista, seu valor é `null`. Essa chave pode ser usada como `selectedValueKey` no endpoint RESOLVE.
catalogId	Número	O identificador do catálogo ao qual o valor pertence.
ID do campo	Número	O identificador do campo ao qual o valor pertence. Para campos do tipo CatalogList, seu valor é `null`.
ordem	Número	Ordem de exibição do valor nos consoles.
estado	Número	Status de valor. `1` indica ativo, `0` indica inativo.

Mensagens de erro

Código	Status HTTP	Mensagem de erro
400	Solicitação BadRequest	InvalidItemType — O itemType fornecido é inválido.
401	Desautorizado	Token não fornecido ou expirado.