Zum Inhalt springen
AcrivaDocs

GetTemplateForm

GET
/api/v1/t/{tenant}/workflows/templates/{template}
curl --request GET \
  --url https://example.com/api/v1/t/example/workflows/templates/example

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

template
required
string

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
object
template
required
Allowed values: InvoiceApproval ContractReview MailDistribution HrFileIntake Custom
definitionId
required
null | string format: uuid
currentVersion
required
integer format: int32
version
required
null | integer format: uint32
isDefault
required
boolean
form
required
Any of: discriminator: template
object
template
required
string
Allowed values: InvoiceApproval
amountField
required
string
rules
required
Array<object>
object
amountFrom
required
null | number format: double
amountTo
required
null | number format: double
field
required
null | string
fieldValue
required
null | string
costCenterId
required
null | string format: uuid
approver
required
object
kind
required
Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner
userId
null | string format: uuid
roleId
null | string format: uuid
table
null | string
fallbackApprover
required
object
kind
required
Allowed values: Member Role Requester CostCenterResponsible ApprovalLimit DeadlineOwner
userId
null | string format: uuid
roleId
null | string format: uuid
table
null | string
fourEyesAmount
required
null | number format: double
secondApprover
required
One of:
null
deadlines
required
object
remindAfterWorkingDays
required
null | integer format: int32
escalateAfterWorkingDays
required
null | integer format: int32
escalationTarget
required
One of:
null
suggestApprover
required
boolean
checkDuplicates
required
boolean
suggestAllocation
required
boolean
collectiveApproval
required
object
enabled
required
boolean
cap
required
null | number format: double
name
required
string
triggerDocumentTypeId
required
null | string format: uuid
designed
required
boolean
Example
{
  "template": "InvoiceApproval",
  "form": {
    "template": "InvoiceApproval",
    "rules": [
      {
        "approver": {
          "kind": "Member"
        }
      }
    ],
    "fallbackApprover": {
      "kind": "Member"
    },
    "secondApprover": {
      "kind": "Member"
    },
    "deadlines": {
      "escalationTarget": {
        "kind": "Member"
      }
    }
  }
}

403

Abschnitt betitelt „403“

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Abschnitt betitelt „404“

Not Found

429

Abschnitt betitelt „429“

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}