Zum Inhalt springen
Acriva

CreateDocumentType

POST
/api/v1/t/{tenant}/document-types
curl --request POST \
  --url https://example.com/api/v1/t/example/document-types \
  --header 'Content-Type: application/json' \
  --data '{ "key": "example", "nameDe": "example", "nameEn": "example", "fields": [ { "key": "example", "type": "Text", "required": true, "labelDe": "example", "labelEn": "example", "options": [ { "key": "example", "labelDe": "example", "labelEn": "example" } ], "referenceTarget": "File" } ] }'

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
object
key
required
string
nameDe
required
string
nameEn
required
string
fields
required
Array<object> | null
object
key
required
string
type
required
Allowed values: Text Number Date Money Enumeration Reference
required
required
boolean
labelDe
required
string
labelEn
required
string
options
Array<object> | null
object
key
required
string
labelDe
required
string
labelEn
required
string
referenceTarget
One of:
null

Responses

Abschnitt betitelt „ Responses “

201

Abschnitt betitelt „201“

Created

Media typeapplication/json
object
id
required
string format: uuid
key
required
string
nameDe
required
string
nameEn
required
string
fields
required
Array<object>
object
key
required
string
type
required
Allowed values: Text Number Date Money Enumeration Reference
required
required
boolean
labelDe
required
string
labelEn
required
string
options
Array<object> | null
object
key
required
string
labelDe
required
string
labelEn
required
string
referenceTarget
One of:
null
isRemoved
boolean
isActive
required
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "fields": [
    {
      "type": "Text",
      "referenceTarget": "File",
      "isRemoved": false
    }
  ]
}

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

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