Workflows

Ein Workflow repräsentiert die Phasen einer Automatisierung, die in ihrer einfachsten Form Quelldaten in Ausgabedokumente umwandelt.

Fields (Felder)

Field	Type	Editable	Description
id	String	false	Die eindeutige ID des Workflows. Wird verwendet, um den Workflow in allen Anfragen zu referenzieren.
name	String	true	Der Name des Workflows.
color	String	true	Die Farbe des Workflow-Symbols in Portant Workflow als Hex-Zeichenkette, mit dem Präfix #.
icon	String	true	Der Name des in Portant Workflow verwendeten Symbols.
status	String	false	Der aktuelle Status des Workflows. Einer der folgenden Werte: - "COMPLETE": Der Workflow kann ausgeführt werden. - "INCOMPLETE": Der Workflow benötigt weitere Konfiguration, bevor er ausgeführt werden kann. - "ARCHIVED": Der Workflow ist nicht mehr verwendbar.
autoCreate	Boolean	false	Wenn true, überwacht der Workflow Quellereignisse und erstellt bei jedem eingehenden Ereignis eine neue Automatisierung.
owner	Owner	false	Der Eigentümer dieses Workflows.
team	Team	false	Das Team, zu dem dieser Workflow gehört.
source	Source	false	Die Datenquelle für diesen Workflow.
documents	Document	false	Die Vorlagendokumente für diesen Workflow.
outgoingWebhook	Outgoing Webhook	false	Der ausgehende Webhook dieses Workflows, der verwendet wird, um Automatisierungsereignisse zu empfangen.
createdByApi	Boolean	false	True, wenn der Workflow über die Developer API erstellt wurde.
createdAt	String	false	Ein ISO 8601-Zeitstempel für den Zeitpunkt der Erstellung des Workflows.
updatedAt	String	false	Ein ISO 8601-Zeitstempel für den Zeitpunkt der letzten Aktualisierung des Workflows.

Example (Beispiel)

```json
{
    "id": "wkf_kGQK9PBWDT1JCr",
    "name": "Invoice Workflow",
    "icon": "DocumentText",
    "color": "#cccccc",
    "status": "COMPLETE",
    "autoCreate": true,
    "owner": {
        "id": "usr_DsH4TGYXs4XPpB",
        "name": "Blake Lockley",
        "email": "blake@portant.co"
    },
    "team": null,
    "source": {
        "id": "src_NZHJYjlgrvklHb",
        "sourceType": "WEBHOOK",
        "sourceFields": [
            "Order Number",
            "LineItem.Name",
            "LineItem.Price",
        ],
        "webhookUrl": "https://webhooks.portant.co/50c7912b14c7acbe9df32521ec60a27c"
    },
    "documents": [
        {
            "id": "doc_5LGGqC5S78RNS0",
            "documentType": "GOOGLE_DOCS",
            "file": {
                "id": "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4",
                "name": "Complete Workflow Please - [Template]",
                "url": "https://docs.google.com/document/d/1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4/edit?usp=drivesdk",
                "mimeType": "application/vnd.google-apps.document"
            },
            "outputName": "Document for {{First Name}}",
            "pdfPassword": "jeRe/\/\eyWaZH3re",
            "enablePdfPassword": true,
            "enablePdfPreventCopy": false,
            "previewUrl": "https://preview.portant.co/doc_5LGGqC5S78RNS0"
        }
    ],
    "outgoingWebhook": {
        "id": "owc_XY1Ys4gqrpX8cp",
        "webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
    },
    "createdByApi": true,
    "createdAt": "2024-08-12T16:20:44.346666+10:00",
    "updatedAt": "2024-08-12T16:20:48.408357+10:00"
}
```

Endpoints (Endpunkte)

List all workflows (Alle Workflows auflisten)

GET /workflows/

Gibt jeden Workflow zurück, der dem API-Benutzer gehört oder mit dessen Team geteilt wurde.

Responses (Antworten)

Status	Body
200 OK	Array<Workflow>
403 Unauthorised	Error

Create a workflow (Einen Workflow erstellen)

POST /workflows/

Erstellt einen neuen Workflow.

Request (Anfrage)

Ein partielles Workflow-Objekt als JSON. Das einzige Pflichtfeld ist name.

{
    name: "A simple workflow"
}

Sie können auch einen vollständigen Workflow in einem einzigen POST erstellen, indem Sie die optionalen Unterkomponenten und deren Pflichtfelder angeben.

Felder mit dem Suffix ? sind optional.

{
    name: "A complete Workflow from Scratch",
    color?: "#...",
    icon?: "...",
    source?: {
        "sourceFields": ["Field Name 1", "Field Name 2"]
    },
    document?: {
        fileId: "<google file id>"
    },
    outgoingWebhook?: {
        webhookUrl: "<webhook url for event listening>"
    }
}

Antworten

Status	Body
201 Created	Workflow
400 Bad Request	Error
403 Unauthorised	Error

Einen Workflow abrufen

GET /workflows/<wkf_id>/

Einen bestimmten Workflow anhand der ID abrufen.

Antworten

Status	Body
200 OK	Workflow
403 Unauthorised	Error
404 Not Found	Error

Einen Workflow aktualisieren

PATCH /workflows/<wkf_id>/

Einen bestimmten Workflow anhand der ID aktualisieren.

Anfrage

Ein partielles Workflow-Objekt als JSON. Felder mit dem Suffix ? sind optional.

{
    name?: "...",
    color?: "#...",
    icon?: "..."
 }

Antwort

Status	Body
200 OK	Workflow
400 Bad Request	Error
403 Unauthorised	Error
404 Not Found	Error

Einen Workflow löschen

DELETE /workflows/<wkf_id>/

Einen bestimmten Workflow anhand der ID löschen. Der Workflow wird nicht tatsächlich gelöscht, sondern sein Status wird auf "ARCHIVED" gesetzt. Archivierte Workflows können durch Kontaktaufnahme mit dem Customer-Success-Team wiederhergestellt werden.

Antwort

Status	Body
204 No Content
400 Bad Request	Error
403 Unauthorised	Error
404 Not Found	Error