API Docs
AbsenceAbsence Additional ContingentAbsence ContingentAccountAccountingAccounting ContactAdded ValueAsset AccountAttachmentAttendanceAuthBank AccountCatalogCommissionContactCraftCredit InvoiceCreditorCustom FilterCustom ReportCustomerCustomFieldDashboardDebitorEmailEmployment ContractEstimateFinanceFinance JournalFinance Journal PositionsFinDocCategoryFollowupForecastGeneral InfoHolidayIntegrationsInvoiceJobJob TasksLogin MethodMeMetricsOffice LocationOrder ConfirmationOrganisationPaymentPersonProcedureProcedure ViewPurchase InvoicePurchase OrderReportResource PlanningSnippetTargetTeamTemplateTimeUserUser CraftUser GroupUser Group ActionsUser Group UsersWorkPattern
POSTProcedure

/procedure

Create a procedure

Creates a procedure with the provided details.

Base URL
https://<tenant>.dieagenturverwaltung.de/api/v2
Required Security
ApiKeyAuth (Authorization: Session Token)
Produces
application/json

Request

Body Parameters

NameTypeRequiredDescription
procedureapp.ProcedureYesProcedure to create

Parameter Models

Inspect object parameters and nested model references without loading the full Swagger file in the browser.

procedureBody parameterapp.Procedure
attachments
array<app.Attachment>
No description.
available_as_task
boolean
No description.
board_cards
array<app.BoardCard>
Board cards associated with the procedure
budget
string
No description.
comments
array<app.Comment>
No description.
date_begin
integer
No description.
date_created
integer
No description.
date_deadline
integer
No description.
date_end
integer
No description.
date_modified
integer
No description.
deleted_at
integer
No description.
description
string
No description.
done_tasks
integer
Number of tasks that are done
estimate_position
app.FinanceJournalPosition
No description.
estimate_position_id
integer
TODO: rename to estimate_position_id
id
integer
No description.
job_id
integer
No description.
job_tasks
array<app.JobTask>
No description.
listeners
array<app.SmallUser>
No description.
name
string
No description.
ordinal_number
integer
TODO: rename to ordinal_number
organisation_id
integer
No description.
person_id
integer
No description.
priority
app.ProcedurePriority
No description.
small_job
app.SmallJob
No description.
small_users
array<app.SmallUser>
No description.
status
app.ProcedureStatus
No description.
tags
array<app.Tag>
No description.
tasks
integer
Total number of tasks
time_estimated
integer
No description.
token
string
No description.
users
array<app.User>
No description.
worktime
number
No description.
cURL
curl -X POST 'https://<tenant>.dieagenturverwaltung.de/api/v2/procedure' \
  -H 'Accept: application/json' \
  -H 'Authorization: Session Token' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "attachments": [
    {}
  ],
  "available_as_task": true,
  "board_cards": [
    {}
  ],
  "budget": "string",
  "comments": [
    {}
  ],
  "date_begin": 123,
  "date_created": 123,
  "date_deadline": 123,
  "date_end": 123,
  "date_modified": 123,
  "deleted_at": 123,
  "description": "string",
  "done_tasks": 123,
  "estimate_position": {},
  "estimate_position_id": 123,
  "id": 123,
  "job_id": 123,
  "job_tasks": [
    {}
  ],
  "listeners": [
    {}
  ],
  "name": "string",
  "ordinal_number": 123,
  "organisation_id": 123,
  "person_id": 123,
  "priority": 1,
  "small_job": {},
  "small_users": [
    {}
  ],
  "status": "nicht begonnen",
  "tags": [
    {}
  ],
  "tasks": 123,
  "time_estimated": 123,
  "token": "string",
  "users": [
    {}
  ],
  "worktime": 123.45
}'
Request Body (application/json)
{
  "attachments": [
    {...}
  ],
  "available_as_task": true,
  "board_cards": [
    {...}
  ],
  "budget": "string",
  "comments": [
    {...}
  ],
  "date_begin": 123,
  "date_created": 123,
  "date_deadline": 123,
  "date_end": 123,
  "date_modified": 123,
  "deleted_at": 123,
  "description": "string",
  "done_tasks": 123,
  "estimate_position": {...},
  "estimate_position_id": 123,
  "id": 123,
  "job_id": 123,
  "job_tasks": [
    {...}
  ],
  "listeners": [
    {...}
  ],
  "name": "string",
  "ordinal_number": 123,
  "organisation_id": 123,
  "person_id": 123,
  "priority": 1,
  "small_job": {...},
  "small_users": [
    {...}
  ],
  "status": "nicht begonnen",
  "tags": [
    {...}
  ],
  "tasks": 123,
  "time_estimated": 123,
  "token": "string",
  "users": [
    {...}
  ],
  "worktime": 123.45
}

Responses

201Created
app.Procedureapplication/json
Example
{
  "attachments": [
    {...}
  ],
  "available_as_task": true,
  "board_cards": [
    {...}
  ],
  "budget": "string",
  "comments": [
    {...}
  ],
  "date_begin": 123,
  "date_created": 123,
  "date_deadline": 123,
  "date_end": 123,
  "date_modified": 123,
  "deleted_at": 123,
  "description": "string",
  "done_tasks": 123,
  "estimate_position": {...},
  "estimate_position_id": 123,
  "id": 123,
  "job_id": 123,
  "job_tasks": [
    {...}
  ],
  "listeners": [
    {...}
  ],
  "name": "string",
  "ordinal_number": 123,
  "organisation_id": 123,
  "person_id": 123,
  "priority": 1,
  "small_job": {...},
  "small_users": [
    {...}
  ],
  "status": "nicht begonnen",
  "tags": [
    {...}
  ],
  "tasks": 123,
  "time_estimated": 123,
  "token": "string",
  "users": [
    {...}
  ],
  "worktime": 123.45
}
400Bad Request
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}
403Forbidden
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}
500Internal Server Error
rest_errors.Errorapplication/json
Example
{
  "code": 123,
  "extras": {...},
  "message": "string",
  "status_code": 123
}