Utiliser des champs personnalisés

Les champs personnalisés sont des champs supplémentaires qui ne font pas initialement partie du modèle de preuves de Genetec Clearance™, mais qui peuvent être inclus dans un élément de preuve lors de l'utilisation de l'API Document Service. Les champs personnalisés vous permettent de stocker des données spécifiques pertinentes pour votre dossier flux de travail.

Pour obtenir les données JSON d'un élément de preuve créé, vous pouvez passer un appel GET au point de terminaison Preuve. Pour modifier ou créer des champs personnalisés au sein de JSON, vous devez accéder au EvidenceID, qui peut être obtenu à l'aide de l'API Search Service.

http

GET https://dems-proda-api.clearance.network/documentstore/api/v1tenant/{tenantName}/evidence/{evidenceId}/

La valeur renvoyée doit ressembler à ceci :

json

{
  "AccessPolicies": [
    {
      "ExpirationDateUtc": "2021-07-26T19:49:37.527Z",
      "Permissions": "None",
      "PermissionSource": {
        "Reason": "None",
        "MergeStrategy": "None",
        "Permissions": "None"
      },
      "KId": "string",
      "Username": "string",
      "PrincipalId": "string",
      "PrincipalType": "string"
    }
  ],
  "AccessorPermissions": [
    "None"
  ],
  "AccessPoliciesGrantType": "None",
  "AssociationState": "None",
  "CategoryId": "string",
  "CreatedBy": {
    "KId": "string",
    "Username": "string",
    "PrincipalId": "string",
    "PrincipalType": "string"
  },
  "CreatedTimeUtc": "2021-07-26T19:49:37.527Z",
  "DeletedBy": {
    "KId": "string",
    "Username": "string",
    "PrincipalId": "string",
    "PrincipalType": "string"
  },
  "DeletedOnUtc": "2021-07-26T19:49:37.527Z",
  "Description": "string",
  "Device": {
    "DeviceType": "string",
    "ExternalId": "string",
    "Manufacturer": "string",
    "SerialNumber": "string",
    "Model": "string"
  },
  "EditingSessionId": "string",
  "EndTimeUtc": "2021-07-26T19:49:37.527Z",
  "EvidenceId": "string",
  "LifecycleState": "None",
  "LocationText": "string",
  "LocationWKT": "string",
  "Name": "string",
  "SourceId": "string",
  "StartTimeUtc": "2021-07-26T19:49:37.527Z",
  "State": "None",
  "Tags": [
    "string"
  ],
  "Thumbnail": "string",
  "CustomFields": {},
  "ConcurrencyId": "string"
}

Nous pouvons ensuite modifier le nœud CustomFields pour ajouter, supprimer ou modifier les champs personnalisés qui apparaissent sur cette preuve.

Exemple :

json

"CustomFields": {
   "customFieldName": "value of this field",
   "customField2": "another value"
}

Ensuite, nous pouvons utiliser un appel PATCH vers le magasin de documents pour mettre à jour les champs personnalisés avec notre nouveau JSON en tant que corps :

http

json

PATCH https://dems-proda-api.clearance.network/documentstore/api/v1/tenant/{tenantName}/evidence/{evidenceId}/

{
  "AccessPolicies": [
    {
      "ExpirationDateUtc": "2021-07-26T19:49:37.527Z",
      "Permissions": "None",
      "PermissionSource": {
        "Reason": "None",
        "MergeStrategy": "None",
        "Permissions": "None"
      },
      "KId": "string",
      "Username": "string",
      "PrincipalId": "string",
      "PrincipalType": "string"
    }
  ],
  "AccessorPermissions": [
    "None"
  ],
  "AccessPoliciesGrantType": "None",
  "AssociationState": "None",
  "CategoryId": "string",
  "CreatedBy": {
    "KId": "string",
    "Username": "string",
    "PrincipalId": "string",
    "PrincipalType": "string"
  },
  "CreatedTimeUtc": "2021-07-26T19:49:37.527Z",
  "DeletedBy": {
    "KId": "string",
    "Username": "string",
    "PrincipalId": "string",
    "PrincipalType": "string"
  },
  "DeletedOnUtc": "2021-07-26T19:49:37.527Z",
  "Description": "string",
  "Device": {
    "DeviceType": "string",
    "ExternalId": "string",
    "Manufacturer": "string",
    "SerialNumber": "string",
    "Model": "string"
  },
  "EditingSessionId": "string",
  "EndTimeUtc": "2021-07-26T19:49:37.527Z",
  "EvidenceId": "string",
  "LifecycleState": "None",
  "LocationText": "string",
  "LocationWKT": "string",
  "Name": "string",
  "SourceId": "string",
  "StartTimeUtc": "2021-07-26T19:49:37.527Z",
  "State": "None",
  "Tags": [
    "string"
  ],
  "Thumbnail": "string",
  "CustomFields": {
    "customFieldName": "value of this field",
    "customField2": "another value"
  },
  "ConcurrencyId": "string"
}