Update attachment metadata.

PUT

/api/workspace/attachments/{fileId}

curl --request PUT \
  --url https://example.com/api/workspace/attachments/example \
  --header 'Content-Type: application/json' \
  --data '{ "Name": "example", "Description": "example", "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Owner": { "ModuleKey": "example", "ResourceKind": "example", "ContextResourceId": "example", "ResourceObjectId": "example" }, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

• None

Parameters

Path Parameters

fileId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

object

Name

string

nullable

Description

string

nullable

OperationKey

string format: uuid

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RowVersion

string format: uuid

Example^generated

{
  "Name": "example",
  "Description": "example",
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

object

Name

string

nullable

Description

string

nullable

OperationKey

string format: uuid

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RowVersion

string format: uuid

Example^generated

{
  "Name": "example",
  "Description": "example",
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

object

Name

string

nullable

Description

string

nullable

OperationKey

string format: uuid

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RowVersion

string format: uuid

Example^generated

{
  "Name": "example",
  "Description": "example",
  "OperationKey": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "Owner": {
    "ModuleKey": "example",
    "ResourceKind": "example",
    "ContextResourceId": "example",
    "ResourceObjectId": "example"
  },
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

OK

Media typeapplication/json

object

Data

object

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

object

Id

string

nullable

FolderId

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

Relations

Array<object>

nullable

object

Id

string

nullable

Target

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

object

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

IsDeleted

boolean

EditDeadline

string format: date-time

RowVersion

string format: uuid

Descriptor

object

Id

string

nullable

FileName

string

nullable

Description

string

nullable

MimeType

string

nullable

StorageType

integer format: int32

Allowed values: 0 1 2 3 4 5

AvailabilityState

integer format: int32

Allowed values: 0 1 2 3 4

DetectedMimeType

string

nullable

ImageWidth

integer format: int32

nullable

ImageHeight

integer format: int32

nullable

ContentGeneration

integer format: int64

InspectedChecksumSha256

string

nullable

InspectedContentGeneration

integer format: int64

nullable

SizeBytes

integer format: int64

ChecksumSha256

string

nullable

CreatedAt

string format: date-time

ModifiedAt

string format: date-time

nullable

CreatedByUserId

string

nullable

CreatedByUserName

string

nullable

ModifiedByUserId

string

nullable

ModifiedByUserName

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Relations": [
      {
        "RelationKind": 0
      }
    ],
    "Descriptor": {
      "StorageType": 0,
      "AvailabilityState": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

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

404

Not Found

Media typeapplication/json

object

Data

object

Id

string

nullable

FolderId

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

Relations

Array<object>

nullable

object

Id

string

nullable

Target

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

RelationKind

integer format: int32

Allowed values: 0

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

CreatedByUserId

string

nullable

CreatedAt

string format: date-time

DeletedAt

string format: date-time

nullable

Origin

object

Source

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

PolicyCode

string

nullable

CorrelationId

string

nullable

IsDeleted

boolean

EditDeadline

string format: date-time

RowVersion

string format: uuid

Descriptor

object

Id

string

nullable

FileName

string

nullable

Description

string

nullable

MimeType

string

nullable

StorageType

integer format: int32

Allowed values: 0 1 2 3 4 5

AvailabilityState

integer format: int32

Allowed values: 0 1 2 3 4

DetectedMimeType

string

nullable

ImageWidth

integer format: int32

nullable

ImageHeight

integer format: int32

nullable

ContentGeneration

integer format: int64

InspectedChecksumSha256

string

nullable

InspectedContentGeneration

integer format: int64

nullable

SizeBytes

integer format: int64

ChecksumSha256

string

nullable

CreatedAt

string format: date-time

ModifiedAt

string format: date-time

nullable

CreatedByUserId

string

nullable

CreatedByUserName

string

nullable

ModifiedByUserId

string

nullable

ModifiedByUserName

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "Relations": [
      {
        "RelationKind": 0
      }
    ],
    "Descriptor": {
      "StorageType": 0,
      "AvailabilityState": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}