Vorgänge

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Vorgänge abrufen

Version 1.0

---

GET/openwowi/v1.0/Commissioning/CraftProcesses

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

ProjectIdnullable integer (int32)

CraftProcessTypeIdinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.0/Commissioning/CraftProcesses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "IdNum": "text",
    "ProjectId": 1,
    "CraftProcessTypeId": 1
  }
]

---

Version 1.2

---

GET/openwowi/v1.2/CommissioningRead/CraftProcesses

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

CraftsProcessDateFromstring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CraftsProcessDateTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CraftsProcessTypenullable all of

CraftProcessStatusnullable all of

CompanyCodenullable all of

Projectnullable all of

EconomicUnitnullable all of

ServicePackagenullable all of

ResponsibleOfficialnullable all of

Commissionsnullable array of object

InvoiceReceiptsnullable array of object

AdditionalFieldsnullable array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningRead/CraftProcesses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "IdNum": "text",
    "CraftsProcessDateFrom": "2025-02-05",
    "CraftsProcessDateTo": "2025-02-05",
    "CraftsProcessType": {
      "Id": 1,
      "Code": "text"
    },
    "CraftProcessStatus": {
      "Id": 1,
      "Code": "text"
    },
    "CompanyCode": {
      "Id": 1,
      "Name": "text",
      "Code": "text"
    },
    "Project": {
      "Id": 1,
      "Code": "text",
      "Name": "text"
    },
    "EconomicUnit": {
      "Id": 1,
      "IdNum": "text"
    },
    "ServicePackage": {
      "Id": 1,
      "IdNum": "text"
    },
    "ResponsibleOfficial": {
      "Id": 1,
      "CodeShort": "text",
      "PersonId": 1
    },
    "Commissions": [
      {
        "Id": 1,
        "IdNum": "text",
        "Code": "text",
        "RecordingDate": "2025-02-05",
        "ReleaseDate": "2025-02-05",
        "PlacingDate": "2025-02-05",
        "AcceptanceDate": "2025-02-05",
        "CompletionDate": "2025-02-05",
        "CommissionType": {
          "Id": 1,
          "Code": "text"
        },
        "CommissionStatus": {
          "Id": 1,
          "Code": "text"
        }
      }
    ],
    "InvoiceReceipts": [
      {
        "Id": 1,
        "InvoiceReceiptNumber": "text"
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ]
  }
]

---

Vorgänge anlegen, ändern und löschen

Hinweise zur Funktion

Die Änderung von vorhandenen Vorgängen unterliegt bestimmten Beschränkungen.

Die CraftsProcessStatusId kann nur auf den Status "4" (Storniert) gesetzt werden.

Status 1 bis 3 errechnet sich aus den Feldern "CraftsProcessFrom" und "CraftsProcessTo". Liegt das aktuelle Tagesdatum vor "CraftsProcessFrom", wird automatisch der Status "1" (Bevorstehend) gesetzt.

Liegt das aktuelle Tagesdatum nach "CraftsProcessFrom" aber vor "CraftsProcessTo", wird automatisch der Status "2" (Offen) gesetzt.

Liegt das aktuelle Tagesdatum nach "CraftsProcessTo", wird automatisch der Status "3" (Beendet) gesetzt.

Sie können den Status durch das Setzen dieser Datumsangaben beeinflussen. Bitte beachten Sie, dass die Ausführungsdaten der mit dem Vorgang verknüpften Aufträge logisch mit diesen Daten übereinstimmen müssen.

Version 1.2

---

POST/openwowi/v1.2/CommissioningEdit/CraftsProcess

Authorization

Authorization

Query parameters

Body

application/jsontext/jsonapplication/*+json

CraftsProcessTypeIdinteger (int32)

CompanyCodeIdinteger (int32)

CraftsProcessStatusIdinteger (int32)

ServicePackageIdnullable integer (int32)

ProjectIdnullable integer (int32)

ManagementIdnullable integer (int32)

OwnerIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

PersonInChargeResponsibleOfficialIdnullable integer (int32)

CraftsProcessFromstring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CraftsProcessTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

IdNumnullable string

Descriptionnullable string

Response

201400401

Created

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/CraftsProcess?apiKey=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "CraftsProcessFrom": "2025-02-05",
      "CraftsProcessTo": "2025-02-05"
    }),
});
const data = await response.json();

Response

201400

{
  "Id": 1,
  "IdNum": "text"
}

---

PUT/openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}

Authorization

Authorization

Path parameters

id*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

CraftsProcessTypeIdinteger (int32)

CompanyCodeIdinteger (int32)

CraftsProcessStatusIdinteger (int32)

ServicePackageIdnullable integer (int32)

ProjectIdnullable integer (int32)

ManagementIdnullable integer (int32)

OwnerIdnullable integer (int32)

EconomicUnitIdnullable integer (int32)

PersonInChargeResponsibleOfficialIdnullable integer (int32)

CraftsProcessFromstring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CraftsProcessTonullable string (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}?apiKey=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "CraftsProcessFrom": "2025-02-05",
      "CraftsProcessTo": "2025-02-05"
    }),
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text"
}

---

DELETE/openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}

Authorization

Authorization

Path parameters

id*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

IdNumnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}?apiKey=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "Id": 1,
  "IdNum": "text"
}

---

Vorgangsbeschreibungen lesen

Version 1.2

---

GET/openwowi/v1.2/CommissioningRead/CraftProcess/Note

Authorization

Authorization

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

Idinteger (int32)

CraftsProcessnullable all of

Usernullable all of

Datestring (date)

Example: "2025-02-05"

Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

Descriptionnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningRead/CraftProcess/Note', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "Id": 1,
    "CraftsProcess": {
      "Id": 1,
      "IdNum": "text"
    },
    "User": {
      "Id": 1,
      "UserName": "text"
    },
    "Date": "2025-02-05",
    "Description": "text"
  }
]

---

Vorgangsbeschreibungen anlegen, ändern und löschen

Version 1.2

---

POST/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note

Authorization

Authorization

Path parameters

craftsProcessId*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

string

Response

201400401

Created

Body

text/plainapplication/jsontext/json

CraftsProcessnullable all of

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note?apiKey=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

201400

{
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  },
  "Id": 1
}

---

PUT/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note/{id}

Authorization

Authorization

Path parameters

craftsProcessId*integer (int32)

id*integer (int32)

Query parameters

Body

application/jsontext/jsonapplication/*+json

string

Response

200400401

OK

Body

text/plainapplication/jsontext/json

CraftsProcessnullable all of

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note/{id}?apiKey=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200400

{
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  },
  "Id": 1
}

---

DELETE/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note/{id}

Authorization

Authorization

Path parameters

craftsProcessId*integer (int32)

id*integer (int32)

Query parameters

Response

200400401

OK

Body

text/plainapplication/jsontext/json

CraftsProcessnullable all of

Idinteger (int32)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note/{id}?apiKey=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  },
  "Id": 1
}

---