GCXONEDocumentatie

Serviceaanvraag Tab

Op deze pagina
  1. POST /serviceRequests/filter
  2. Verzoek‑body
  3. Responsen
  4. PUT /serviceRequests/updateStatus/{serviceRequestId}
  5. Parameters
  6. Verzoek body
  7. Responses

Operaties op serviceaanvraag‑tab resources. 2 eindpunten, elk relatief ten opzichte van https://api.nxgen.cloud/api/v1 en geauthenticeerd zoals beschreven onder Authenticatie.

POST /serviceRequests/filter

Haal lijst met serviceaanvragen op met filteren, sorteren en paginering. Het ondersteunt zoeken op hiërarchisch niveau. Het kan gefilterd worden met een opgegeven hiërarchie of gebruikt de hiërarchie van de ingelogde gebruiker. Dit biedt de mogelijkheid om extra entiteitsvelden in de respons op te nemen. Biedt tevens configuratiemetadata over de entiteit.

Verzoek‑body

Filteren en sorteren van serviceaanvragen

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

Responsen

Status

Beschrijving

Body

200

Success

object

204

Geen inhoud

400

Ongeldige invoer

401

Niet toegestaan

403

Forbidden

Voorbeeld 200 respons:

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}

Werk een serviceaanvraag bij

Parameters

Naam

In

Type

Vereist

Beschrijving

serviceRequestId

pad

string

ja

Verzoek body

json
{
  "status": "string"
}

Responses

Status

Beschrijving

Body

200

Succes

400

Ongeldige invoer

401

Ongeautoriseerd

403

Verboden

404

Niet gevonden

Voorbeeld 200 respons:

json
{
  "result": "serviceRequestId"
}
Was deze pagina nuttig?

Bedankt — uw feedback gaat naar het team dat deze pagina beheert.