Teil des Integration Service

Inhaltsverzeichnis:

1 CustomFieldSets abrufen
2 CustomFieldSet Instanzen abrufen
3 CustomFieldSet Felder beschreiben
4 CustomFieldSet Type
5 EditorType

CustomFieldSets abrufen

Endpunkt: GET - /api/v1/CustomFieldSets?onlyConfigured={onlyConfigured}
Version: 2.21.221
Beschreibung: Ruft alle CustomFieldSets ab

Beispiel Request

/api/v1/customfieldsets?onlyConfigured=true

Wenn onlyConfigured auf true gesetzt wurde werden nur noch CustomFieldSet zurückgegeben die für die WebApp in antony Konfiguriert wurden

Beispiel Response

[
  {
    "setId": 0,
    "name": "string",
    "icon": "string",
    "fields": [
      {
        "fieldId": 0,
        "fieldGuid": "string",
        "name": "string",
        "fieldName": "string",
        "contentType": "string",
        "isSearchable": true,
        "type": 0,
        "editorType": 1 // Erst verfügbar ab v2.24.30
      }
    ]
  }
]

Der EditorType ist erst ab Version 2.24.30 von antony verfügbar!

Was im type stehen kann finden Sie ganz unten auf der aktuellen Seite

CustomFieldSet Instanzen abrufen

Endpunkt: GET - /api/v1/CustomFieldSets/{setId}?skip={skip}&take={take}&returnNull={returnNull}
Version: 2.22.117
Beschreibung: Ruft Instanzen des angegebenen CustomFieldSets ab

Beispiel Request:

http://localhost:1337/api/v1/CustomFieldSets/1?skip=0&take=5&returnNull=true

returnNull kann entweder true oder false sein. Mit diesem Parameter kann man entscheiden ob auch Felder ausgegeben werden sollen die keinen Wert beinhalten

Beispiel Response

[
    {
        "instanceId": "ed3c837b-6036-455c-9d6d-d3a6fb1c9bab",
        "fields": {
            "field_1": "Wert im Feld 1",
            "field_2": "Wert im Feld 2",
            "field_7": "0001-01-01T00:00:00",
        }
    }
]

CustomFieldSet Felder beschreiben

Endpunkt: POST - /api/v1/CustomFieldSets/{setId}/{instanceId}
Version: 2.22.117
Beschreibung: Beschreibt die angegebenen Felder in der angegebenen CustomFieldSet Instanz

Beispiel Request:

http://localhost:1337/api/v1/CustomFieldSets/1/ed3c837b-6036-455c-9d6d-d3a6fb1c9bab

Beispiel Request

{
      "field_1": "Wert im Feld 1",
      "field_2": "Wert im Feld 2"
  }

WICHTIG: Die Keys in “fields” müssen KLEIN geschrieben werden.

Beispiel Response

{
    "type": 0,
    "data": {
        "instanceId": "ed3c837b-6036-455c-9d6d-d3a6fb1c9bab"
    },
    "message": null
}

CustomFieldSet Type

Der Type kann einen der unten aufgeführten Werte enthalten:

0 - String
1 - LongString
2 - Numeric
3 - Double
4 - Image
5 - Date
6 - DateTime
7 - Link
8 - Boolean

EditorType

Der Typ kann folgende Werte enthalten:

0 - Kein Editor angegeben
1 - Checkbox
2 - Auswahlbox
3 - Datumsfeld
4 - Notizfeld
5 - Bild
6 - Textfeld
7 - Nummernfeld
8 - Benutzerauswahl
9 - Titelauswahl
10 - Landauswahl
11 - Fortlaufende Nummer
12 - Kontaktauswahl