GCXONEDocumentation

Onglet Demande de service

Sur cette page
  1. POST /serviceRequests/filter
  2. Corps de la demande
  3. Réponses
  4. PUT /serviceRequests/updateStatus/{serviceRequestId}
  5. Paramètres
  6. Corps de la Demande
  7. Réponses

Opérations sur les ressources de l'onglet demande de service. 2 points de terminaison, chacun relatif à https://api.nxgen.cloud/api/v1 et authentifié comme décrit sous Authentification.

POST /serviceRequests/filter

Obtenir la liste des demandes de service avec filtrage, tri et pagination. Permet la recherche par niveau hiérarchique. Peut être filtré en utilisant la hiérarchie spécifiée ou utilise la hiérarchie de l'utilisateur connecté. Cela offre la possibilité d'obtenir des champs d'entité supplémentaires dans la réponse. Fournit également les métadonnées de configuration sur l'entité.

Corps de la demande

Filtrage et tri des demandes de service

json
{
  "filters": [
    {
      "columnName": "string (required)",
      "type": "distinctList | date | number | StringConditionFilter (required)",
      "filter": "object (required)"
    }
  ],
  "sortOrder": [
    {
      "columnName": "string",
      "isAscending": "boolean"
    }
  ],
  "primaryColumns": [
    "string"
  ],
  "hierarchyLevel": "string",
  "hierarchyId": "string",
  "nPerPage": "number",
  "pageNumber": "number",
  "isConfigDetailRequired": "boolean",
  "getConfig": "boolean",
  "getChildOrParent": "boolean"
}

Réponses

Statut

Description

Corps

200

Succès

objet

204

Pas de contenu

400

Entrée invalide

401

Non autorisé

403

Interdit

Exemple 200 réponse :

json
{
  "config": {
    "columns": [
      {
        "visibility": true,
        "columnName": "commercialName",
        "DisplayName": "Site",
        "isFilterable": true,
        "filterType": "stringCondition",
        "sticky": true,
        "isRightBorder": true,
        "isMandatory": true,
        "isNotDraggable": true
      }
    ],
    "defaultNPerPage": 50,
    "defaultFilterCondition": [],
    "defaultSortingOrder": [
      {
        "columnName": "dateTime",
        "isAscending": false
      }
    ],
    "maxVisibleColumnCount": 6,
    "exportLimitNPerPage": 500
  },
  "dataResult": [
    {
      "category": "tower",
      "subCategory": "new_tower",
      "uniqueId": "c772ac8dd22f4a9a8849c332afe3f188",
      "userId": "d76dfac772ac8dcb7db87a6c772ac8d",
      "createdOn": 1655213317621
    },
    {
      "category": "tower",
      "subCategory": "new_tower",
      "uniqueId": "c772ac8dd22f4a9a8849c332afe3f188",
      "userId": "d76dfac772ac8dcb7db87a6c772ac8d",
      "createdOn": 1655213317621
    }
  ],
  "totalRecordsCount": 3552,
  "filteredBy": [],
  "sortedBy": [
    {
      "columnName": "dateTime",
      "isAscending": false
    }
  ],
  "dispatchedAll": false,
  "isDefaultProjectionMutated": false,
  "isDefaultFilterMutated": false,
  "isDefaultSortingMutated": false
}

PUT /serviceRequests/updateStatus/{serviceRequestId}

Mettre à jour une demande de service

Paramètres

Nom

Dans

Type

Obligatoire

Description

serviceRequestId

chemin

chaîne

oui

Corps de la Demande

json
{
  "status": "string"
}

Réponses

Statut

Description

Corps

200

Succès

400

Entrée invalide

401

Non autorisé

403

Interdit

404

Pas trouvé

Exemple 200 réponse:

json
{
  "result": "serviceRequestId"
}
Cette page vous a-t-elle été utile ?

Merci — votre retour est transmis à l’équipe responsable de cette page.