API Custom Field Service

Le Custom Field Service est un service qui permet aux utilisateurs de gérer des entrées de données personnalisées pour des champs personnalisés, des preuves et des dossiers à locataire unique dans Genetec Clearance™ en mettant en œuvre certains modèles. Selon leur type, ces modèles contiennent les champs personnalisés qui doivent être affichés à la création et lors de la modification de preuves ou de dossiers.

La suppression d'un champ personnalisé d'un modèle ne le supprime pas d'un dossier ou d'une preuve tant que ce champ contient une valeur. Le modèle contient également des champs par défaut renommés, qui sont des étiquettes alternatives pour les champs qui sont dans des dossiers et des preuves par défaut, comme Description.

Pour la documentation interactive du Custom Field Service, voir dems-proda-api.clearance.network.

Utiliser le Custom Field Service

En utilisant une demande GET avec le service champ personnalisé, nous pouvons voir les modèles de champs personnalisés pour les dossiers et les preuves associés à un locataire :

http

GET https://dems-dev-api.clearancedev.net/customfieldservice/api/v1/template/{tenantName}

Ce qui est renvoyé ressemble à ceci :

json

[
  {
    "type": "Case",
    "renamedFields": [
      {
        "fieldId": "CadNumberTitle",
        "customName": "INumber"
      },
      {
        "fieldId": "RecordNumber",
        "customName": "TestRecordNumber"
      },
      {
        "fieldId": "IncidentNumber",
        "customName": "TestIncidentNumber"
      },
      {
        "fieldId": "OccurredOn",
        "customName": "Incident Start Time"
      }
    ],
    "customFields": [
      {
        "name": "Area",
        "type": "Text"
      },
      {
        "name": "casetest",
        "type": "Text"
      },
      {
        "name": "casetest2",
        "type": "Text"
      }
    ],
    "lastModifiedUtc": "2021-07-26T15:31:27.4511975+00:00",
    "lastModifiedBy": {
      "firstName": "",
      "lastName": "",
      "username": "aperson@anemail.com",
      "principalId": 6001,
      "principalType": "user",
      "kId": "https://dems-dev-keyvault.vault.azure.net:443/keys/genetecdev"
    }
  },
  {
    "type": "Evidence",
    "renamedFields": [
      {
        "fieldId": "DescriptionTitle",
        "customName": "New Description1"
      },
      {
        "fieldId": "TagsTitle",
        "customName": "Tagerinno"
      },
      {
        "fieldId": "Description",
        "customName": "EvidenceDescription"
      },
      {
        "fieldId": "StartTime",
        "customName": "Evidence Start Time"
      }
    ],
    "customFields": [
      {
        "name": "Area",
        "type": "Text"
      },
      {
        "name": "VehicleID",
        "type": "Text"
      },
      {
        "name": "Shift",
        "type": "Text"
      },
      {
        "name": "Agency",
        "type": "Text"
      }
    ],
    "lastModifiedUtc": "2021-07-26T15:32:51.6860126+00:00",
    "lastModifiedBy": {
      "firstName": "",
      "lastName": "",
      "username": "aperson@anemail.com",
      "principalId": 6001,
      "principalType": "user",
      "kId": "https://dems-dev-keyvault.vault.azure.net:443/keys/genetecdev"
    }
  }
]

Pour ajouter ou mettre à jour un modèle, vous pouvez utiliser une demande PUT :

http

https://dems-dev-api.clearancedev.net/customfieldservice/api/v1/template/{tenantName}

Le corps JSON suivant utilise le type « Dossier » ou « Preuve » (consulter la documentation interactive pour voir la prise en charge actuelle de fieldIds pour le renommage) :

json

{
  "type": "Case",
  "renamedFields": [
    {
      "fieldId": "string",
      "customName": "string"
    }
  ],
  "customFields": [
    {
      "name": "string",
      "type": "Text"
    }
  ],
  "lastModifiedUtc": "2021-07-26T20:15:22.482Z",
  "lastModifiedBy": {
    "firstName": "string",
    "lastName": "string",
    "username": "string",
    "principalId": 0,
    "principalType": "string",
    "kId": "string"
  }
}