GCXONEDokumentation

Service-Anfrage Tab

Auf dieser Seite
  1. POST /serviceRequests/filter
  2. Anfrage‑Body
  3. Antworten
  4. PUT /serviceRequests/updateStatus/{serviceRequestId}
  5. Parameter
  6. Anfrage-Body
  7. Antworten

Operationen für Service‑Anfrage‑Tab‑Ressourcen. 2 Endpunkte, jeweils relativ zu https://api.nxgen.cloud/api/v1 und authentifiziert wie unter Authentifizierung.

POST /serviceRequests/filter

Abrufen der Service‑Anfrage‑Liste mit Filterung, Sortierung und Paginierung. Es ermöglicht die Suche auf hierarchischer Ebene. Es kann anhand einer angegebenen Hierarchie gefiltert werden oder verwendet die Hierarchie des angemeldeten Benutzers. Dadurch besteht die Möglichkeit, zusätzliche Entitätsfelder in der Antwort zu erhalten. Außerdem werden Konfigurations‑Metadaten zur Entität bereitgestellt.

Anfrage‑Body

Service‑Anfrage‑Filterung und -Sortierung

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

Antworten

Status

Beschreibung

Body

200

Erfolg

Objekt

204

Kein Inhalt

400

Ungültige Eingabe

401

Nicht autorisiert

403

Verboten

Beispiel 200 Antwort:

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}

Service‑Anfrage aktualisieren

Parameter

Name

In

Typ

Erforderlich

Beschreibung

serviceRequestId

Pfad

String

ja

Anfrage-Body

json
{
  "status": "string"
}

Antworten

Status

Beschreibung

Body

200

Erfolg

400

Ungültige Eingabe

401

Nicht autorisiert

403

Verboten

404

Nicht gefunden

Beispiel 200 Antwort:

json
{
  "result": "serviceRequestId"
}
War diese Seite hilfreich?

Vielen Dank — Ihr Feedback geht an das Team, das diese Seite betreut.