Zum Inhalt springen
AcrivaDocs

SetDocumentTypeDeadlineRules

PUT
/api/v1/t/{tenant}/document-types/{documentTypeId}/deadline-rules
curl --request PUT \
  --url https://example.com/api/v1/t/example/document-types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deadline-rules \
  --header 'Content-Type: application/json' \
  --data '{ "rules": { "contractTerm": { "fields": { "start": "example", "initialTerm": "example", "end": "example", "renewal": "example", "noticePeriod": "example", "noticeBasis": "example", "currentEnd": "example", "noticeDate": "example", "status": "example", "partner": "example" }, "owner": { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "noticeReminderDays": 90, "endReminderDays": 30 }, "dateFields": [ { "fieldKey": "example", "labelDe": "example", "labelEn": "example", "reminderDays": 1, "owner": { "kind": "Member", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } } ] }, "version": 1 }'

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

documentTypeId
required
string format: uuid

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
object
rules
required
One of:
null
version
required
integer format: uint32

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
object
documentTypeId
required
string format: uuid
rules
required
object
contractTerm
required
One of:
null
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"
        }
      }
    ]
  }
}

400

Abschnitt betitelt „400“

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

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

409

Abschnitt betitelt „409“

Conflict

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"
}

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"
}