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
Authorizations
Query parameters
apiKeystringOptional
Responses
200
OK
get
GET /openwowi/v1.0/Commissioning/CraftProcesses HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Version 1.2

get
Authorizations
Query parameters
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
idinteger · int32Optional
idNumstringOptional
companyCodeIdinteger · int32Optional
companyCodeCodestringOptional
craftsProcessTypeIdinteger · int32Optional
includeCommissionbooleanOptionalDefault: false
includeInvoiceReceiptbooleanOptionalDefault: false
includeAdditionalFieldbooleanOptionalDefault: false
includeInsuranceDatabooleanOptionalDefault: false
showNullValuesbooleanOptionalDefault: false
Responses
200
OK
get
GET /openwowi/v1.2/CommissioningRead/CraftProcesses HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "ShortDescriptionCraftsProcess": "text",
    "CraftsProcessDateFrom": "2025-06-27",
    "CraftsProcessDateTo": "2025-06-27",
    "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"
    },
    "Land": {
      "Id": 1,
      "IdNum": "text"
    },
    "Building": {
      "Id": 1,
      "IdNum": "text"
    },
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text"
    },
    "LicenseAgreement": {
      "Id": 1,
      "IdNum": "text"
    },
    "ServicePackage": {
      "Id": 1,
      "IdNum": "text"
    },
    "ResponsibleOfficial": {
      "Id": 1,
      "CodeShort": "text",
      "PersonId": 1
    },
    "InsuranceData": {
      "Id": 1,
      "TimeDamage": "2025-06-27",
      "MajorLossIndicator": true,
      "EstimatedAmountOfDamage": 1,
      "InsurerClaimNumber": "text",
      "AvailablePoliceReport": true,
      "PoliceReportDate": "2025-06-27",
      "FileNumber": "text",
      "PoliceDepartment": "text",
      "DamageCause": {
        "Id": 1,
        "IdNum": "text",
        "DamageCause": "text"
      },
      "DamageDivision": {
        "Id": 1,
        "IdNum": "text",
        "DivisionDamage": "text"
      }
    },
    "Commissions": [
      {
        "Id": 1,
        "IdNum": "text",
        "Code": "text",
        "RecordingDate": "2025-06-27",
        "ReleaseDate": "2025-06-27",
        "PlacingDate": "2025-06-27",
        "AcceptanceDate": "2025-06-27",
        "CompletionDate": "2025-06-27",
        "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
Authorizations
Query parameters
apiKeystringRequired
Body
ShortDescriptionCraftsProcessstring | nullableOptional
CraftsProcessTypeIdinteger · int32Optional
CompanyCodeIdinteger · int32Optional
CraftsProcessStatusIdinteger · int32Optional
ServicePackageIdinteger · int32 | nullableOptional
ProjectIdinteger · int32 | nullableOptional
ManagementIdinteger · int32 | nullableOptional
OwnerIdinteger · int32 | nullableOptional
EconomicUnitIdinteger · int32 | nullableOptional
BuildingIdinteger · int32 | nullableOptional
LandIdinteger · int32 | nullableOptional
UseUnitIdinteger · int32 | nullableOptional
LicenseAgreementIdinteger · int32 | nullableOptional
PersonInChargeResponsibleOfficialIdinteger · int32 | nullableOptional
CraftsProcessFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])
CraftsProcessTostring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])
IdNumstring | nullableOptional
Descriptionstring | nullableOptional
Responses
201
Created
post
POST /openwowi/v1.2/CommissioningEdit/CraftsProcess?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 666

{
  "ShortDescriptionCraftsProcess": "text",
  "CraftsProcessTypeId": 1,
  "CompanyCodeId": 1,
  "CraftsProcessStatusId": 1,
  "ServicePackageId": 1,
  "ProjectId": 1,
  "ManagementId": 1,
  "OwnerId": 1,
  "EconomicUnitId": 1,
  "BuildingId": 1,
  "LandId": 1,
  "UseUnitId": 1,
  "LicenseAgreementId": 1,
  "PersonInChargeResponsibleOfficialId": 1,
  "CraftsProcessFrom": "2025-06-27",
  "CraftsProcessTo": "2025-06-27",
  "InsuranceData": {
    "DamageCauseId": 1,
    "DamageDivisionId": 1,
    "PoliceDepartment": "text",
    "PoliceReportDate": "2025-06-27",
    "FileNumber": "text",
    "AvailablePoliceReport": true,
    "InsurerClaimNumber": "text",
    "EstimatedAmountOfDamage": 1,
    "MajorLossIndicator": true,
    "TimeDamage": "2025-06-27"
  },
  "IdNum": "text",
  "Description": "text"
}
{
  "Id": 1,
  "IdNum": "text"
}
put
Authorizations
Path parameters
idinteger · int32Required
Query parameters
apiKeystringRequired
Body
ShortDescriptionCraftsProcessstring | nullableOptional
CraftsProcessTypeIdinteger · int32Optional
CompanyCodeIdinteger · int32Optional
CraftsProcessStatusIdinteger · int32Optional
ServicePackageIdinteger · int32 | nullableOptional
ProjectIdinteger · int32 | nullableOptional
ManagementIdinteger · int32 | nullableOptional
OwnerIdinteger · int32 | nullableOptional
EconomicUnitIdinteger · int32 | nullableOptional
BuildingIdinteger · int32 | nullableOptional
LandIdinteger · int32 | nullableOptional
UseUnitIdinteger · int32 | nullableOptional
LicenseAgreementIdinteger · int32 | nullableOptional
PersonInChargeResponsibleOfficialIdinteger · int32 | nullableOptional
CraftsProcessFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])
CraftsProcessTostring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])
Responses
200
OK
put
PUT /openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 630

{
  "ShortDescriptionCraftsProcess": "text",
  "CraftsProcessTypeId": 1,
  "CompanyCodeId": 1,
  "CraftsProcessStatusId": 1,
  "ServicePackageId": 1,
  "ProjectId": 1,
  "ManagementId": 1,
  "OwnerId": 1,
  "EconomicUnitId": 1,
  "BuildingId": 1,
  "LandId": 1,
  "UseUnitId": 1,
  "LicenseAgreementId": 1,
  "PersonInChargeResponsibleOfficialId": 1,
  "CraftsProcessFrom": "2025-06-27",
  "CraftsProcessTo": "2025-06-27",
  "InsuranceData": {
    "DamageCauseId": 1,
    "DamageDivisionId": 1,
    "PoliceDepartment": "text",
    "PoliceReportDate": "2025-06-27",
    "FileNumber": "text",
    "AvailablePoliceReport": true,
    "InsurerClaimNumber": "text",
    "EstimatedAmountOfDamage": 1,
    "MajorLossIndicator": true,
    "TimeDamage": "2025-06-27"
  }
}
{
  "Id": 1,
  "IdNum": "text"
}
delete
Authorizations
Path parameters
idinteger · int32Required
Query parameters
apiKeystringRequired
Responses
200
OK
delete
DELETE /openwowi/v1.2/CommissioningEdit/CraftsProcess/{id}?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Vorgangsbeschreibungen lesen

Version 1.2

get
Authorizations
Query parameters
apiKeystringOptional
limitinteger · int32OptionalExample: 20
offsetinteger · int32Optional
idinteger · int32Optional
craftsProcessIdinteger · int32Optional
craftsProcessIdNumstringOptional
companyCodeIdinteger · int32Optional
companyCodeCodestringOptional
showNullValuesbooleanOptionalDefault: false
Responses
200
OK
get
GET /openwowi/v1.2/CommissioningRead/CraftProcess/Note HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Vorgangsbeschreibungen anlegen, ändern und löschen

Version 1.2

post
Authorizations
Path parameters
craftsProcessIdinteger · int32Required
Query parameters
apiKeystringRequired
Body
stringOptional
Responses
201
Created
post
POST /openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  },
  "Id": 1
}
put
Authorizations
Path parameters
craftsProcessIdinteger · int32Required
idinteger · int32Required
Query parameters
apiKeystringRequired
Body
stringOptional
Responses
200
OK
put
PUT /openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note/{id}?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  },
  "Id": 1
}
delete
Authorizations
Path parameters
craftsProcessIdinteger · int32Required
idinteger · int32Required
Query parameters
apiKeystringRequired
Responses
200
OK
delete
DELETE /openwowi/v1.2/CommissioningEdit/CraftsProcess/{craftsProcessId}/Note/{id}?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Last updated