Skip to content
AcrivaDocs

UpdateFileTypeKeyFields

PUT
/api/v1/t/{tenant}/file-types/{fileTypeId}/key-fields
curl --request PUT \
  --url https://example.com/api/v1/t/example/file-types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/key-fields \
  --header 'Content-Type: application/json' \
  --data '{ "keyFields": [ { "key": "example", "type": "Text", "required": true, "unique": true, "labelDe": "example", "labelEn": "example", "options": [ { "key": "example", "labelDe": "example", "labelEn": "example" } ], "referenceTarget": "File", "isRemoved": true } ], "version": 1 }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

fileTypeId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
keyFields
required
Array<object> | null
object
key
required
string
type
required
Allowed values: Text Number Date Money Enumeration Reference Period
required
required
boolean
unique
required
boolean
labelDe
required
string
labelEn
required
string
options
required
Array<object> | null
object
key
required
string
labelDe
required
string
labelEn
required
string
referenceTarget
required
One of:
null
isRemoved
required
boolean
version
required
integer format: uint32

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

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

400

Section titled “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

Section titled “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

Section titled “404”

Not Found

409

Section titled “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

Section titled “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"
}