GetDocumentTypeDeadlineRules

GET

/api/v1/t/{tenant}/document-types/{documentTypeId}/deadline-rules

curl --request GET \
  --url https://example.com/api/v1/t/example/document-types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deadline-rules

Parameters

Path Parameters

tenant

required

string

Tenant slug

documentTypeId

required

string format: uuid

Responses

200

OK

Media typeapplication/json

object

documentTypeId

required

string format: uuid

rules

required

object

contractTerm

required

One of:

null

null

object

object

fields

required

object

start

null | string

initialTerm

null | string

end

null | string

renewal

null | string

noticePeriod

null | string

noticeBasis

null | string

currentEnd

null | string

noticeDate

null | string

status

null | string

partner

null | string

owner

required

object

kind

required

Allowed values: Member Role PartnerResponsible Uploader

userId

null | string format: uuid

roleId

null | string format: uuid

noticeReminderDays

integer format: int32

default: 90

endReminderDays

integer format: int32

default: 30

dateFields

required

Array<object>

object

fieldKey

required

string

labelDe

required

string

labelEn

required

string

reminderDays

required

integer format: int32

owner

required

object

kind

required

Allowed values: Member Role PartnerResponsible Uploader

userId

null | string format: uuid

roleId

null | string format: uuid

version

required

integer format: uint32

skippedStandardFields

required

Array<string>

Example

{
  "rules": {
    "contractTerm": {
      "owner": {
        "kind": "Member"
      },
      "noticeReminderDays": 90,
      "endReminderDays": 30
    },
    "dateFields": [
      {
        "owner": {
          "kind": "Member"
        }
      }
    ]
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

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

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}